Get the OpenAPI contract
Download the worker's generated OpenAPI 3.1 contract for this WorkspaceAPI version.
API 2.7.0 · Published service contract ↗
Request
Base URL: https://app.sym.so/v1/workspaces/{workspace_id}
Authentication: public. Required scope: Public contract.
GET /openapi.json
Download the worker's generated OpenAPI 3.1 contract for this WorkspaceAPI version.
curl --fail-with-body -X GET "https://app.sym.so/v1/workspaces/$WORKSPACE_ID/openapi.json"{
"openapi": "3.1.0",
"info": {
"title": "Symposium WorkspaceAPI",
"version": "2.6.1"
},
"paths": {
"/api-keys": {
"get": {
"summary": "List my workspace API keys"
},
"post": {
"summary": "Create a workspace API key"
}
},
"/agents": {
"get": {
"summary": "List Agents"
}
},
"/agents/{agent_id}/settings": {
"get": {
"summary": "Get Agent runtime settings"
},
"put": {
"summary": "Update Agent runtime settings"
}
},
"/agents/{agent_id}/secrets": {
"get": {
"summary": "List Agent secret configuration"
},
"post": {
"summary": "Set or remove Agent secrets"
}
}
}
}Authorization
{
"type": "public",
"scope": "Public contract",
"transport": "No credential required."
}Errors
| Status | Description |
|---|---|
| 404 | The worker does not expose this API version. |
| 503 | The generated OpenAPI artifact is unavailable on the worker. |