Interacting with the API

API request

Requests can be performed to at https://api.cobbery.com.

All application responses will be application/json, however upstream errors (e.g. Load Balancer 503 errors) may return text/plain or other content types.

202 responses currently do not return a body.

Generating an API key

Developers and Admins can visit the API Keys page of the dashboard to generate API keys.

API Keys have an id to identify them in the audit log and a secret to actually use them with the API.

Authenticating requests

Authentication with the API can be done with either of the following headers:

• Authorization: Bearer {secret}
• auth: {secret}

Request and Response bodies

We document them as Typescript interfaces since that serves as a good middle ground for Agents to convert between languages, without using having to write overly verbose OpenAPI schemas.

This may change in the future.