Create an agent session
client.Beta.Agents.Sessions.New(ctx, body) (*AgentSession, error)
POST/agents/sessions
Creates a managed agent session, optionally submits initial input, and returns the session or streams its events when stream is true. See running sessions.
Create an agent session
package main
import (
"context"
"fmt"
"github.com/openai/openai-go"
"github.com/openai/openai-go/option"
)
func main() {
client := openai.NewClient(
option.WithAPIKey("My API Key"),
)
agentSession, err := client.Beta.Agents.Sessions.New(context.TODO(), openai.BetaAgentSessionNewParams{
Environment: openai.EnvironmentParamUnion{
OfNone: &openai.EnvironmentParamNone{
},
},
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", agentSession.ID)
}
{
"id": "id",
"agent": {
"id": "id",
"instructions": "instructions",
"model": "model",
"multi_agent": {
"enabled": true,
"max_concurrent_subagents": 1
},
"name": "name",
"reasoning": {
"effort": "none",
"summary": "concise"
},
"service_tier": "auto",
"text": {
"format": {
"type": "text"
},
"verbosity": "low"
},
"tools": [
{
"defer_loading": true,
"description": "description",
"name": "name",
"parameters": {
"foo": "bar"
},
"type": "function"
}
]
},
"created_at": 0,
"environment": {
"type": "none"
},
"error": "error",
"last_active_at": 0,
"metadata": {
"foo": "string"
},
"object": "agent.session",
"required_actions": [
{
"request": {
"credential_origin": "credential_origin",
"fields": [
{
"id": "id",
"label": "label",
"required": true,
"type": "type"
}
],
"options": [
{
"id": "id",
"field_ids": [
"string"
],
"label": "label"
}
],
"reason": "reason",
"type": "browser_authentication"
},
"request_id": "request_id",
"turn_id": "turn_id",
"type": "computer_use_approval_request"
}
],
"status": "idle",
"usage": {
"input_tokens": 0,
"input_tokens_details": {
"cached_tokens": 0
},
"output_tokens": 0,
"output_tokens_details": {
"reasoning_tokens": 0
},
"total_tokens": 0
},
"vault_ids": [
"string"
],
"spend_control": {
"consumed": 0,
"limit": 1
}
}Returns Examples
{
"id": "id",
"agent": {
"id": "id",
"instructions": "instructions",
"model": "model",
"multi_agent": {
"enabled": true,
"max_concurrent_subagents": 1
},
"name": "name",
"reasoning": {
"effort": "none",
"summary": "concise"
},
"service_tier": "auto",
"text": {
"format": {
"type": "text"
},
"verbosity": "low"
},
"tools": [
{
"defer_loading": true,
"description": "description",
"name": "name",
"parameters": {
"foo": "bar"
},
"type": "function"
}
]
},
"created_at": 0,
"environment": {
"type": "none"
},
"error": "error",
"last_active_at": 0,
"metadata": {
"foo": "string"
},
"object": "agent.session",
"required_actions": [
{
"request": {
"credential_origin": "credential_origin",
"fields": [
{
"id": "id",
"label": "label",
"required": true,
"type": "type"
}
],
"options": [
{
"id": "id",
"field_ids": [
"string"
],
"label": "label"
}
],
"reason": "reason",
"type": "browser_authentication"
},
"request_id": "request_id",
"turn_id": "turn_id",
"type": "computer_use_approval_request"
}
],
"status": "idle",
"usage": {
"input_tokens": 0,
"input_tokens_details": {
"cached_tokens": 0
},
"output_tokens": 0,
"output_tokens_details": {
"reasoning_tokens": 0
},
"total_tokens": 0
},
"vault_ids": [
"string"
],
"spend_control": {
"consumed": 0,
"limit": 1
}
}