Create Connection

POST/v1/openai-agents/connections

Base URL *

Your instance endpoint, shown on the instance page in the dashboard. Each instance has its own host; there is no shared API host.

Authorization (Bearer token)

Request Body (JSON)

Request Body

JSON request bodies are capped at 2 MiB.

Property	Type	Required
`name`	`string`	Yes
`api_key`	`string`	Yes
`executor_key`	`string`	No
`project_id`	`string`	No
`organization_id`	`string`	No
`principal_id`	`string`	No
`allowed_models`	`string[]`	No

Responses

201 Success

Property	Type	Description
`id`	`string`
`name`	`string`
`provider`	`string`
`project_id`	`string`
`organization_id`	`string`
`principal_id`	`string`
`allowed_models`	`string[]`
`status`	`string`
`last_error`	`string`
`created_at`	`string`
`updated_at`	`string`

400 Invalid request

Property	Type	Description
`error`	`object`

403 Permission denied

Property	Type	Description
`error`	`object`

404 Not found

Property	Type	Description
`error`	`object`

500 Internal error

Property	Type	Description
`error`	`object`

503 Unavailable

Property	Type	Description
`error`	`object`

Request

curl -X POST "http://localhost:8089/v1/openai-agents/connections" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","api_key":"string","executor_key":"string","project_id":"string","organization_id":"string","principal_id":"string","allowed_models":["string"]}'

const response = await fetch("http://localhost:8089/v1/openai-agents/connections", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "name": "string",
  "api_key": "string",
  "executor_key": "string",
  "project_id": "string",
  "organization_id": "string",
  "principal_id": "string",
  "allowed_models": [
    "string"
  ]
}),
});
const data = await response.json();

import requests

response = requests.post(
    "http://localhost:8089/v1/openai-agents/connections",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    json={
  "name": "string",
  "api_key": "string",
  "executor_key": "string",
  "project_id": "string",
  "organization_id": "string",
  "principal_id": "string",
  "allowed_models": [
    "string"
  ]
},
)
data = response.json()

Response

{
  "id": "string",
  "name": "string",
  "provider": "string",
  "project_id": "string",
  "organization_id": "string",
  "principal_id": "string",
  "allowed_models": [
    "string"
  ],
  "status": "string",
  "last_error": "string",
  "created_at": "string",
  "updated_at": "string"
}

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string"
  }
}