Studio API
Send Studio API requests from your own code, or see how the MCP adapter sends them.
StudioThe Studio API, webhooks, and MCP adapter are included with the Studio plan.Compare plans
API or MCP
Use direct HTTP calls when you control the client, for example your own script, server or agent framework. Use the MCP adapter when an MCP host, for example Claude or Gemini, must use GearDex tools.
The two methods use the same Studio API key, scopes, audit log and webhooks. You can start with one method and add the other later.
Build a client
- Create a Studio API key.
- Give the key only the scopes that your client needs.
- Send the key as a bearer token in each request. See Authentication.
- Send requests to the endpoints. Or, generate a client from the OpenAPI document. See the OpenAPI guide.
- Use backoff when you send a failed request again. See Responses and errors and Rate limits.
How MCP calls the API
- The host calls an MCP tool, for example
list_shoots. - The adapter finds the Studio API endpoint for that tool.
- The adapter sends a request with your key as a bearer token.
- The Studio API checks the scopes and the record owner, and writes an audit log entry.
- The adapter returns the JSON response to the host as the tool result.
The tool map shows each tool and the endpoint that it calls.
Adapter behavior
| Aspect | Kind | Behavior |
|---|---|---|
| Auth | behavior | The adapter sends GEARDEX_STUDIO_API_KEY as a bearer token on each request. |
| Timeout | behavior | Each API call has a 20 second limit, which includes redirects and the response. The maximum response size is 2 MiB. |
| Redirect handling | behavior | The adapter follows a maximum of three redirects in the API path. It sends the key only to the same origin or to HTTPS GearDex addresses. A redirect for a write must keep the HTTP method. |
| State | behavior | The adapter keeps no credentials and no sessions. |
| Write access | behavior | Write tools use the same write scopes, audit log and webhooks as direct HTTP calls. |