OpenAI-compatible

Get a model

GET
/api/v1/openai/models/{model_id}

One agent, by its id or its exact name in any case. An unknown one is a 404 with the code model_not_found, in OpenAI's error shape. See OpenAI-compatible API.

apiKey
headerAuthorizationBearer <token>

An API key, sk-syn- and 32 characters. On SynapseOrch Cloud an owner or admin makes it under Settings → Developer; on a self-hosted install, under Settings → API Keys.

model_id*string

The agent's id, or its exact name.

The agent, as a model.

application/json
  1. response
id?string
object?string
created?integer
owned_by?string
name?string
synapse?
curl -X GET "https://api.synapseorch.com/api/v1/openai/models/Support Bot" \  -H "Authorization: Bearer sk-syn-..."
{  "id": "agent_1726412345678",  "object": "model",  "created": 1726412345,  "owned_by": "synapse",  "name": "Support Bot",  "synapse": {    "type": "agent"  }}