Create Connection

POST/everstack.openai_agents.v1.OpenAIAgentsService/CreateConnection

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

Property	Type	Required
`name`	`string`	No
`apiKey`	`string`	No
`executorKey`	`string`	No
`projectId`	`string`	No
`organizationId`	`string`	No
`principalId`	`string`	No
`allowedModels`	`string[]`	No

Responses

200 A successful response.

Property	Type	Description
`connection`	`object`

default An unexpected error response.

Property	Type	Description
`code`	`integer`
`message`	`string`
`details`	`object[]`

Request

curl -X POST "http://localhost:8089/everstack.openai_agents.v1.OpenAIAgentsService/CreateConnection" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","apiKey":"string","executorKey":"string","projectId":"string","organizationId":"string","principalId":"string","allowedModels":["string"]}'

const response = await fetch("http://localhost:8089/everstack.openai_agents.v1.OpenAIAgentsService/CreateConnection", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "name": "string",
  "apiKey": "string",
  "executorKey": "string",
  "projectId": "string",
  "organizationId": "string",
  "principalId": "string",
  "allowedModels": [
    "string"
  ]
}),
});
const data = await response.json();

import requests

response = requests.post(
    "http://localhost:8089/everstack.openai_agents.v1.OpenAIAgentsService/CreateConnection",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    json={
  "name": "string",
  "apiKey": "string",
  "executorKey": "string",
  "projectId": "string",
  "organizationId": "string",
  "principalId": "string",
  "allowedModels": [
    "string"
  ]
},
)
data = response.json()

Response

{
  "connection": {
    "id": "string",
    "name": "string",
    "provider": "string",
    "projectId": "string",
    "organizationId": "string",
    "principalId": "string",
    "allowedModels": [
      "string"
    ],
    "status": "string",
    "lastError": "string",
    "createdAt": "2024-01-01T00:00:00Z",
    "updatedAt": "2024-01-01T00:00:00Z"
  }
}

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}