# Gobare Agent API Docs

- [Gobare Agent API](https://docs.gobare.dev/index.md)
- [Quickstart](https://docs.gobare.dev/quickstart.md): First time. Token to completed turn, in one page
- [Production integration](https://docs.gobare.dev/production-integration.md): It works, and now it has to keep working
- [Model credentials](https://docs.gobare.dev/model-credentials.md): You want to connect a model without opening the Console
- [Sessions](https://docs.gobare.dev/sessions.md): You want a session to hold your repo, files, secrets or limits
- [Agents](https://docs.gobare.dev/saved-agents.md): You want every session in one part of your product to start the same way
- [Input](https://docs.gobare.dev/input.md): You want to send the agent a message, a result, a steer or a stop
- [Events](https://docs.gobare.dev/events.md): You want to watch a session instead of polling it
- [Tools](https://docs.gobare.dev/tools.md): You want to give the agent your functions, or an MCP server
- [Required actions](https://docs.gobare.dev/required-actions.md): You want the agent to call *your* code
- [Webhooks](https://docs.gobare.dev/webhooks.md): You want to be told rather than to watch
- [Idempotency](https://docs.gobare.dev/idempotency.md): Your caller retries, and you need it not to act twice
- [Preview](https://docs.gobare.dev/preview.md): You want what the agent built to be reachable by other people
- [Guides](https://docs.gobare.dev/guides.md)
- [Turn documents into structured JSON](https://docs.gobare.dev/guides/extracting-structured-data.md): Turn a pile of PDFs, contracts or reports into rows in my database
- [Put an agent behind your own API](https://docs.gobare.dev/guides/an-agent-behind-your-api.md): Hand work to an agent from my own API and collect it later
- [Require human approval before the agent acts](https://docs.gobare.dev/guides/approvals-in-your-product.md): Make a person approve something before the agent does it
- [Stream the agent's progress into your UI](https://docs.gobare.dev/guides/showing-the-agents-work.md): Show my users what the agent is doing, live
- [Continue work across hours and rounds](https://docs.gobare.dev/guides/work-that-spans-hours.md): Keep one job going across hours, pausing in between
- [Swap model providers without changing your code](https://docs.gobare.dev/guides/switching-model-providers.md): Change model or vendor without touching my code
- [TypeScript client](https://docs.gobare.dev/typescript.md): You are past `curl` and putting this in a service
- [Python client](https://docs.gobare.dev/python.md): The same, in Python
- [Troubleshooting](https://docs.gobare.dev/troubleshooting.md): Something looks wrong and you want it by symptom, not by endpoint
- [Errors](https://docs.gobare.dev/errors.md): Something returned a code you have not seen
- [Limits](https://docs.gobare.dev/limits.md): You are planning load, or you got a 429
- [Pagination](https://docs.gobare.dev/pagination.md): A collection has more rows than one page, or you need to find a session by your own id
- [Objects](https://docs.gobare.dev/objects.md): What each response and request shape contains
- [Changelog](https://docs.gobare.dev/changelog.md): You want to know what changed, and when
- [Design decisions](https://docs.gobare.dev/design-decisions.md): You want to know why the API behaves as it does
- [The session loop](https://docs.gobare.dev/run-session.md): The loop, written out, to copy into your project
- [Build an integration](https://docs.gobare.dev/AGENTS.md): The client is an agent. The whole build order in one pass, with a check after every step and a self-test at the end
- [Check the access token](https://docs.gobare.dev/api-reference/check-the-access-token.md): Check the access token and report what it may do.
- [List sessions](https://docs.gobare.dev/api-reference/list-sessions.md): List the organization's sessions.
- [Create a session](https://docs.gobare.dev/api-reference/create-a-session.md): Create a session, optionally with an opening message.
- [Retrieve a session](https://docs.gobare.dev/api-reference/retrieve-a-session.md): Retrieve one session.
- [Delete a session](https://docs.gobare.dev/api-reference/delete-a-session.md): Delete a session and destroy its sandbox.
- [Update a session](https://docs.gobare.dev/api-reference/update-a-session.md): Change a session: title, metadata, instructions, or its safety settings.
- [List turns](https://docs.gobare.dev/api-reference/list-turns.md): List a session's turns.
- [Retrieve a turn](https://docs.gobare.dev/api-reference/retrieve-a-turn.md): Retrieve one turn.
- [Stream a session's events](https://docs.gobare.dev/api-reference/stream-a-sessions-events.md): Stream a session's events, resumable with Last-Event-ID.
- [Send input to a session](https://docs.gobare.dev/api-reference/send-input-to-a-session.md): Send input to a session: a message, a cancellation, or a tool result.
- [Stream every session's events](https://docs.gobare.dev/api-reference/stream-every-sessions-events.md): Stream every session the organization owns.
- [List items](https://docs.gobare.dev/api-reference/list-items.md): List a session's durable items.
- [Fork a session](https://docs.gobare.dev/api-reference/fork-a-session.md): Branch a session, workspace and transcript included.
- [Read a session's tools](https://docs.gobare.dev/api-reference/read-a-sessions-tools.md): Read a session's tool configuration.
- [Replace a session's tools](https://docs.gobare.dev/api-reference/replace-a-sessions-tools.md): Replace a session's tool configuration.
- [List webhooks](https://docs.gobare.dev/api-reference/list-webhooks.md): List the organization's webhook subscriptions.
- [Create a webhook](https://docs.gobare.dev/api-reference/create-a-webhook.md): Subscribe an endpoint to session events.
- [Delete a webhook](https://docs.gobare.dev/api-reference/delete-a-webhook.md): Remove a webhook subscription.
- [List artifacts](https://docs.gobare.dev/api-reference/list-artifacts.md): List files this session's turns published.
- [Download all artifacts](https://docs.gobare.dev/api-reference/download-all-artifacts.md): Download every artifact as one tar.
- [Retrieve an artifact](https://docs.gobare.dev/api-reference/retrieve-an-artifact.md): Retrieve one artifact's metadata.
- [Delete an artifact](https://docs.gobare.dev/api-reference/delete-an-artifact.md): Delete a published artifact.
- [Download an artifact](https://docs.gobare.dev/api-reference/download-an-artifact.md): Download an artifact's bytes.
- [List workspace files](https://docs.gobare.dev/api-reference/list-workspace-files.md): List the files in a session's workspace.
- [Write workspace files](https://docs.gobare.dev/api-reference/write-workspace-files.md): Write files into a running session's workspace.
- [Read a workspace file](https://docs.gobare.dev/api-reference/read-a-workspace-file.md): Read one file from a session's workspace.
- [Refresh the workspace](https://docs.gobare.dev/api-reference/refresh-the-workspace.md): Capture a fresh snapshot of the workspace, so a read sees current files.
- [List agents](https://docs.gobare.dev/api-reference/list-agents.md): List the organization's agents.
- [Create or replace an agent](https://docs.gobare.dev/api-reference/create-or-replace-an-agent.md): Create or replace a named agent.
- [Retrieve an agent](https://docs.gobare.dev/api-reference/retrieve-an-agent.md): Retrieve one agent.
- [Delete an agent](https://docs.gobare.dev/api-reference/delete-an-agent.md): Delete an agent.
- [List environment templates](https://docs.gobare.dev/api-reference/list-environment-templates.md): Deprecated alias for GET /agents.
- [Create an environment template](https://docs.gobare.dev/api-reference/create-an-environment-template.md): Deprecated alias for POST /agents.
- [Retrieve an environment template](https://docs.gobare.dev/api-reference/retrieve-an-environment-template.md): Deprecated alias for GET /agents/{agent_id}.
- [Delete an environment template](https://docs.gobare.dev/api-reference/delete-an-environment-template.md): Deprecated alias for DELETE /agents/{agent_id}.
- [List environment profiles](https://docs.gobare.dev/api-reference/list-environment-profiles.md): List the organization's environment profiles.
- [List model providers](https://docs.gobare.dev/api-reference/list-model-providers.md): The model providers this deployment can connect, and their defaults.
- [List model connections](https://docs.gobare.dev/api-reference/list-model-connections.md): List the organization's model connections.
- [Connect a model provider](https://docs.gobare.dev/api-reference/connect-a-model-provider.md): Connect a model provider with one of your own keys.
- [Remove a model connection](https://docs.gobare.dev/api-reference/remove-a-model-connection.md): Remove a model connection.
- [Publish a preview](https://docs.gobare.dev/api-reference/publish-a-preview.md): Publish this session's preview at a public URL.
- [Unpublish a preview](https://docs.gobare.dev/api-reference/unpublish-a-preview.md): Take this session's preview off its public URL.
- [Retrieve the OpenAPI document](https://docs.gobare.dev/api-reference/retrieve-the-openapi-document.md): This API's OpenAPI 3.1 document.

## OpenAPI Specs

- [openapi](/openapi.json)