Prospector Studio exposes a GraphQL API for all client-server communication. Connector developers and integration builders can use this API to interact with the platform programmatically.
Endpoint
- HTTP:
POST /api/graphql - WebSocket:
/api/graphql/websocket(subscriptions)
Authentication
All requests require a valid OIDC token. The token is validated against Keycloak and scoped to a tenant and user.
curl -X POST https://studio.example.com/api/graphql \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{"query": "{ listMcpServers { id name } }"}'
Retrieving Your OIDC Token
- Log out of your Studio domain.
- Open your browser's DevTools and switch to the Network tab.
- Log in to your Studio domain.
- In DevTools, scroll back to the top of the network list, then click on the first
v1alphaentry. - In the request details, navigate to Response. You'll see the OIDC token in the line that starts with
"jwt".
Tokens expire at regular intervals. Repeat these steps to retrieve a fresh token.
Schema
The GraphQL schema covers:
- Conversations — Create, list, and manage chat conversations
- Messages — Send messages and receive streamed responses
- Agents — CRUD operations for agent configuration
- Knowledge Bases — Manage knowledge bases and documents
- Workflows — Define, execute, and monitor workflows
- MCP Servers — List servers and query available tools
- Connectors — Query connector apps and capabilities
- Feature Flags — Query enabled features
Subscriptions
Real-time updates are delivered via GraphQL subscriptions over WebSocket:
- Message streaming — Token-by-token LLM responses
- Document processing — Status updates as documents are indexed
- Workflow execution — Task status changes during workflow runs
Explore
A GraphiQL interface is available at https://studio.strike48.com/api/v1alpha/graphiql.