Skip to main content

API and SDKs

The Forge exposes automation capabilities through a REST API and companion SDKs. These interfaces will let you orchestrate agents, submit jobs, and integrate Kothar data into external systems programmatically.

Limited preview

API access is currently in limited preview. If you want access, reach out to the Kothar team so we can discuss your use case and help you get started.

Start with the Python SDK Tutorial​

If you are new to The Forge API, start with this end-to-end tutorial:

It walks through token setup, selecting agents, running direct executions, creating workspace files, and scheduling and polling jobs.

API Reference​

The full API reference is available here:

The reference includes:

  • Endpoint groups for agents, executions, files, and jobs.
  • Request and response schemas for each operation.
  • HTTP method and route details for every endpoint.
  • Authentication requirements and status code documentation.

Authentication and Base URL​

All API requests are served from:

  • https://api.kotharcomputing.com

Use bearer-token authentication in the Authorization header:

  • Authorization: Bearer <api_token>

Create Tokens and Copy IDs in Workshop​

Use the Workshop UI to create API tokens and retrieve the IDs required by the API.

  1. Click your user account icon.
  2. Select Manage account.
  3. Open the API tokens section.
  4. Create a token and use it as Authorization: Bearer <api_token>.

Workspace and agent identifiers are also available from Workshop menus:

  • Workspace ID: open User Preferences, then select Copy Workspace ID.
  • Agent ID: right-click an agent, then select Copy Agent ID.
Use workspace ID, not alias

API tokens are not associated with a user alias. Use the actual workspace ID in API calls, not the personal workspace alias.

API vs SDKs​

Use the REST API when you need direct HTTP control or integrations from any language/runtime.
Use SDKs when you want a higher-level interface with less boilerplate in application code.

The Python SDK is available on PyPI:

SDK beta

The Python SDK is currently in beta.