How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

B3 Contract API

The Contract API from B3 — 11 operation(s) for contract.

B3 Contract API is one of 39 APIs that B3 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Contract. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 13 operations across 11 paths, and defines 44 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against the base URL https://api.b3os.org/v1.

13 operations 11 paths 44 schemas 1 DELETE4 GET7 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://api.b3os.org/v1
Resource Areas
1

Paths & Operations 13

Across 11 paths, the API surfaces 13 operations — 1 DELETE, 4 GET, 7 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Contract 13
POST
/v1/contract
Create a new contract project
body → 201400500
POST
/v1/contract/chat/stream
Stream AI chat for smart contract development via SSE
body → 200400
GET
/v1/contract/session/{sessionId}
Get a contract project by session ID
1 param → 200404
DELETE
/v1/contract/{id}
Delete a contract project by ID
1 param → 200404
GET
/v1/contract/{id}
Get a contract project by ID
1 param → 200404
PUT
/v1/contract/{id}
Update a contract project
1 param body → 200400404500
POST
/v1/contract/{id}/audit
Run audit for a contract project
1 param → 200400404500
POST
/v1/contract/{id}/deploy/approve
Approve and initiate contract deployment to testnet or mainnet
1 param body → 200400404
GET
/v1/contract/{id}/download
Download contract project as Foundry ZIP
1 param → 200404500
POST
/v1/contract/{id}/fix
Trigger AI auto-fix for a contract with failed tests
1 param → 200400404500
POST
/v1/contract/{id}/plan/approve
Approve a contract plan to proceed with code generation
1 param body → 200400404
POST
/v1/contract/{id}/test
Run tests for a contract project
1 param → 200400404500
GET
/v1/contract/{id}/verification-status
Check verification status for all deployments of a contract project
1 param → 200404

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.Template (26 properties), github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.ContractProject (18 properties), github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.ContractSource (14 properties), github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.DeployResult (14 properties). Each schema is shown below with its type and property counts.

github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.ConnectorReference
object
nil if action doesn't need connector
2 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.NodePosition
object
2 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.WorkflowInput
object
4 properties
ApproveContractDeploySuccessResponse
object
4 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.ContractProject
object
18 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.CommentReply
object
5 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.SuccessResponse
object
4 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.WorkflowNode
object
9 properties 2 required
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.Comment
object
9 properties
internal_app_api_http_v1_contract.SaveProjectRequest
object
5 properties 1 required
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.ContractProjectStatus
string
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse
object
4 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.PropSchema
object
8 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.StickyNote
object
9 properties
ContractChatParams
object
3 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.AuditSummary
object
7 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.TemplateVisibility
string
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.StickyNoteUser
object
2 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.DeployResult
object
14 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.AuditReport
object
4 properties
CheckVerificationStatusResponse
object
1 property
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.AuditFinding
object
8 properties
ContractPlanApproval
object
1 property
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.Template
object
26 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.WorkflowUIMetadata
object
3 properties
GetContractProjectSuccessResponse
object
4 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.WorkflowDefinition
object
Definition is the full workflow graph to execute. Must contain a "root" node with type "manual". All action nodes referenced in children arrays must be present.
3 properties 1 required
DeploymentVerificationStatus
object
4 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.TemplateProp
object
8 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.ContractSource
object
14 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.ContractPlanSummary
object
5 properties
ApproveContractPlanParams
object
1 property 1 required
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.TestResults
object
8 properties
ContractChatAction
string
Optional explicit action
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.StickyNoteSize
object
2 properties
ApproveContractDeployParams
object
6 properties 3 required
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.Tag
object
12 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.Deployments
object
Deployments is populated from the contractdeployments table, NOT from a DB column. Kept for backward-compatible JSON serialization in API responses.
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.DeploymentEstimate
object
6 properties
ContractDeployApproval
object
3 properties
ApproveContractPlanSuccessResponse
object
4 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.VerificationStatus
string
Verification status
github_com_b3-fun_b3-mono_services_b3os-workflow_PaginatedData-github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity_Template
object
4 properties
data
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

b3-contract-api-openapi.yml Raw ↑

Other APIs B3 publishes across the network.

B3 Action API
B3 Actions API
B3 Admin API
B3 Ai API
B3 Api Keys API
B3 Connector Types API
B3 Connectors API
B3 Contracts API
B3 CU API
B3 faucet API
B3 Integrations API
B3 Internal API
Where this information came from

This is an independent, third-party profile of B3 Contract API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.