OpenBot API

Call the deployed API.

Use API keys, OpenAPI, and openbot-sdk. Each released operation uses the same access controls, metering, prepaid credits, and job states.

Read API reference Open Platform Playground

Live: HTTP routes
OpenAPI: 3.1 spec
Unified: access + metering

client.py

# Python SDK · authenticated platform request
from openbot_sdk import Client

ob = Client()
health = ob.request("GET", "/health")
print(health)

One contract, three steps.

Get an API key

Create a key in the dashboard and grant only the scopes your integration needs.

Call a live route

Inspect OpenAPI, then call an endpoint with curl or the thin Python SDK.

Handle the response

Use explicit errors, timeouts, retries, and idempotency for reliable clients.

Developer experience

One key. One API contract.

Verify credentials with the non-billable context probe, then discover released APIs from OpenAPI.

context.py

from openbot_sdk import Client

ob = Client()  # reads OPENBOT_API_KEY
context = ob.request("GET", "/v1/me")

print(context["organization_id"])
print(context["api_key"]["scopes"])

What this supports.

LLM agents

Let agents discover and call the current API contract through scoped credentials.

Contract tests

Test authentication, validation, errors, retries, and rate limits against the deployed contract.

Async jobs

Submit a job, poll its explicit state, and retrieve the result artifact when the operation completes.