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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
B3

B3 Contract API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

B3 Contract API is one of 72 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 65 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

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

13 operations 11 paths 65 schemas 1 DELETE4 GET7 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.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 contract
postV1Contract body → 201400500
POST
/v1/contract/chat/stream
Create contract chat stream
postV1ContractChatStream body → 200400
GET
/v1/contract/session/{sessionId}
Get contract session by session id
getV1ContractSessionBySessionId 1 param → 200404
DELETE
/v1/contract/{id}
Delete contract by id
deleteV1ContractById 1 param → 200404
GET
/v1/contract/{id}
Get contract by id
getV1ContractById 1 param → 200404
PUT
/v1/contract/{id}
Replace contract by id
putV1ContractById 1 param body → 200400404500
POST
/v1/contract/{id}/audit
Create contract by id audit
postV1ContractByIdAudit 1 param → 200400404500
POST
/v1/contract/{id}/deploy/approve
Create contract by id deploy approve
postV1ContractByIdDeployApprove 1 param body → 200400404
GET
/v1/contract/{id}/download
Get contract by id download
getV1ContractByIdDownload 1 param → 200404500
POST
/v1/contract/{id}/fix
Create contract by id fix
postV1ContractByIdFix 1 param → 200400404500
POST
/v1/contract/{id}/plan/approve
Create contract by id plan approve
postV1ContractByIdPlanApprove 1 param body → 200400404
POST
/v1/contract/{id}/test
Create contract by id test
postV1ContractByIdTest 1 param → 200400404500
GET
/v1/contract/{id}/verification-status
Get contract by id verification status
getV1ContractByIdVerificationStatus 1 param → 200404

Schemas 65

The contract defines 65 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_2 (36 properties), github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.PropSchema_2 (27 properties), 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). Each schema is shown below with its type and property counts.

github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.WorkflowInput
object
4 properties
ApproveContractPlanSuccessResponse
object
4 properties
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.TemplateVisibility
string
GetContractProjectSuccessResponse
object
4 properties
ContractChatAction
string
Optional explicit action
ContractPlanApproval
object
1 property
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
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.StickyNoteSize
object
2 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.StickyNote
object
9 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.ContractProjectStatus
string
ContractChatParams
object
3 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.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.DeploymentEstimate
object
6 properties
ApproveContractDeploySuccessResponse
object
4 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.PropSchema
object
8 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.TestResults
object
8 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
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.AuditFinding
object
8 properties
ApproveContractDeployParams
object
6 properties 3 required
ContractDeployApproval
object
3 properties
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.AuditReport
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.VerificationStatus
string
Verification status
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.StickyNoteUser
object
2 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.ContractPlanSummary
object
5 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.DeployResult
object
14 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.WorkflowUIMetadata
object
3 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.TemplateProp
object
8 properties
ApproveContractPlanParams
object
1 property 1 required
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.ContractSource
object
14 properties
data
object
1 property
DeploymentVerificationStatus
object
4 properties
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.Comment
object
9 properties
CheckVerificationStatusResponse
object
1 property
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.Template_2
object
36 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.TableSchema
object
1 property
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.BlockExpansionMeta
object
5 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.VariableType
string
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.PropSchema_2
object
27 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.ColumnSchema
object
6 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.WorkflowDefinition_2
object
Definition is the inline workflow graph to analyze. Same shape as a saved workflow's definition. Unlike the ephemeral-run endpoint there is no trigger restrict…
6 properties 1 required
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.BlockOutputProperty
object
3 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.PropVisibleWhen
object
VisibleWhen controls conditional visibility: show this prop only when the referenced prop has the specified value.
2 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.PropSource
object
3 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.ConnectorReference_2
object
nil if action doesn't need connector
4 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.BlockNodeContext
object
BlockContext is set on nodes that were expanded from a block. It traces the node back to its source block and carries the inputMapping needed to resolve {{$inp…
4 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.WorkflowNode_2
object
10 properties 2 required
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.PropColumn
object
11 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.PropSchemaSummaryAggregate
object
3 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.PropSchemaSummary
object
Summary drives the csvTable footer summary. Nil means no summary is rendered. See PropSchemaSummary for details.
2 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.VariableDef
object
5 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.TemplateProp_2
object
8 properties
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.VariableLifetime
string
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.TemplateModerationStatus
string
Moderation fields (B3-4168). Only meaningful for public templates; org templates are always approved.
github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.BlockOutput
object
6 properties

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
AE Profile APIs.io
B3 Actions API
AE Profile APIs.io
B3 Admin API
AE Profile APIs.io
B3 Ai API
AE Profile APIs.io
B3 Api Keys API
AE Profile APIs.io
B3 Connector Types API
AE Profile APIs.io
B3 Connectors API
AE Profile APIs.io
B3 Contracts API
AE Profile APIs.io
B3 CU API
AE Profile APIs.io
B3 Faucet API
AE Profile APIs.io
B3 Integrations API
AE Profile APIs.io
B3 Internal API
AE Profile APIs.io
#Contract
← Back to B APIs
API Details
ID
b3:b3-contract-api
Base URL
https://api.b3os.org/v1
Docs
https://docs.b3.fun/data/api-reference/index
Provider
B3
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=b3-contract-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/b3-contract-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

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.