Create Session

POST/everstack.openai_agents.v1.OpenAIAgentsService/CreateSession

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
`connectionId`	`string`	No
`idempotencyKey`	`string`	No
`model`	`string`	No
`instructions`	`string`	No
`environment`	`object`	No
`input`	`object`	No
`tools`	`object[]`	No

Responses

200 A successful response.

Property	Type	Description
`session`	`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/CreateSession" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"connectionId":"string","idempotencyKey":"string","model":"string","instructions":"string","environment":{"type":"string","workspaceDirectory":"string"},"tools":[{"type":"string","resourceId":"string","name":"string"}]}'

const response = await fetch("http://localhost:8089/everstack.openai_agents.v1.OpenAIAgentsService/CreateSession", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "connectionId": "string",
  "idempotencyKey": "string",
  "model": "string",
  "instructions": "string",
  "environment": {
    "type": "string",
    "workspaceDirectory": "string"
  },
  "tools": [
    {
      "type": "string",
      "resourceId": "string",
      "name": "string"
    }
  ]
}),
});
const data = await response.json();

import requests

response = requests.post(
    "http://localhost:8089/everstack.openai_agents.v1.OpenAIAgentsService/CreateSession",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    json={
  "connectionId": "string",
  "idempotencyKey": "string",
  "model": "string",
  "instructions": "string",
  "environment": {
    "type": "string",
    "workspaceDirectory": "string"
  },
  "tools": [
    {
      "type": "string",
      "resourceId": "string",
      "name": "string"
    }
  ]
},
)
data = response.json()

Response

{
  "session": {
    "id": "string",
    "provider": "string",
    "connectionId": "string",
    "conversationId": "string",
    "upstreamSessionId": "string",
    "upstreamEnvironmentId": "string",
    "sandboxId": "string",
    "model": "string",
    "environment": {
      "type": "string",
      "workspaceDirectory": "string"
    },
    "status": "string",
    "readiness": "string",
    "cleanupStatus": "string",
    "environmentCleanupStatus": "string",
    "lastError": "string",
    "createdAt": "2024-01-01T00:00:00Z",
    "updatedAt": "2024-01-01T00:00:00Z"
  }
}

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