GraphQL Queries Reference

All available GraphQL queries, organized by domain. Each entry lists the query name, parameters, return type, and a brief description.

tip

All queries are sent as POST requests to /graphql. See GraphQL API Overview for authentication and usage examples.

Agents

Query	Parameters	Return Type	Description
`listAgents`	`projectId: String!`	`[Agent]`	List all agents with their current status
`databaseAgents`	`projectId: String!`	`[Agent]`	Agents with hierarchy and team information
`agentProfile`	`projectId: String!`, `agentId: Long!`	`AgentProfile`	Agent profile including email settings
`agentProfileByName`	`projectId: String!`, `agentName: String!`	`AgentProfile`	Look up agent profile by service name
`agentEmailRules`	`projectId: String!`, `agentId: Long!`	`[AgentEmailRule]`	Email processing rules for an agent
`agentEmailInbox`	`projectId: String!`, `agentId: Long!`, `limit: Int`, `offset: Int`	`[AgentEmail]`	Paginated inbox messages
`agentEmailOutbox`	`projectId: String!`, `agentId: Long!`, `limit: Int`, `offset: Int`	`[AgentEmail]`	Paginated outbox (pending approval) messages
`agentEmailTrash`	`projectId: String!`, `agentId: Long!`, `limit: Int`, `offset: Int`	`[AgentEmail]`	Paginated trashed messages
`agentKnownContacts`	`projectId: String!`, `agentId: Long!`	`[AgentContact]`	Contacts the agent has interacted with

Templates

Query	Parameters	Return Type	Description
`agentTemplates`	`category: String`, `featuredOnly: Boolean`	`[AgentTemplate]`	Browse available agent templates, optionally filtered
`agentTemplateCategories`	(none)	`[String]`	List all template category names
`starterTeams`	(none)	`[StarterTeam]`	List all starter team configurations
`starterTeam`	`slug: String!`	`StarterTeam`	Get a specific starter team by slug

Services

Query	Parameters	Return Type	Description
`serviceInfo`	`projectId: String!`, `serviceName: String!`	`ServiceInfo`	Get status and details for a specific service
`listServices`	`projectId: String!`	`[ServiceInfo]`	List all running services in a project
`nameAvailable`	`projectId: String!`, `name: String!`	`Boolean`	Check if a service name is available

Jobs

Query	Parameters	Return Type	Description
`jobs`	`projectId: String!`, `status: String`	`[Job]`	List jobs, optionally filtered by status
`job`	`id: Long!`	`Job`	Get a specific job by ID
`jobSchedules`	`projectId: String!`	`[JobSchedule]`	List all scheduled jobs in a project
`jobSchedule`	`id: Long!`	`JobSchedule`	Get a specific job schedule by ID

Skills & Procedures

Query	Parameters	Return Type	Description
`procedures`	`projectId: String!`, `agentName: String!`	`[Procedure]`	List all procedures for an agent
`procedure`	`projectId: String!`, `agentName: String!`, `procedureName: String!`	`Procedure`	Get a specific procedure
`procedureAgents`	`projectId: String!`	`[String]`	List agent names that have procedures
`skills`	`projectId: String!`, `agentName: String!`	`[Skill]`	List all skills for an agent
`skill`	`projectId: String!`, `agentName: String!`, `skillName: String!`	`Skill`	Get a specific skill
`skillAgents`	`projectId: String!`	`[String]`	List agent names that have skills
`skillFiles`	`projectId: String!`, `agentName: String!`	`[SkillFile]`	List all skill files for an agent

Projects

Query	Parameters	Return Type	Description
`projects`	(none)	`[Project]`	List all projects the current user has access to
`project`	`projectId: String!`	`Project`	Get a specific project
`projectSetting`	`projectId: String!`	`ProjectSetting`	Get project-level settings (timezone, etc.)
`listIntegrations`	`projectId: String!`	`[Integration]`	List configured integrations for a project
`projectReadme`	`projectId: String!`	`String`	Get the project README content

Workspaces

Query	Parameters	Return Type	Description
`myWorkspaces`	(none)	`[Workspace]`	List all workspaces belonging to the current user

Xircuits

Query	Parameters	Return Type	Description
`listXircuits`	`projectId: String!`	`[Xircuit]`	List Xircuits workflows in the project
`listOtherXircuits`	`projectId: String!`	`[Xircuit]`	List Xircuits from other sources
`listServiceXircuits`	`projectId: String!`	`[Xircuit]`	List Xircuits associated with services

Data / Vector

Query	Parameters	Return Type	Description
`listVectorSpaces`	`projectId: String!`	`[VectorSpace]`	List all vector spaces in a project
`vectorSpace`	`projectId: String!`, `vectorSpaceId: Long!`	`VectorSpace`	Get a specific vector space
`listData`	`projectId: String!`, `vectorSpaceId: Long!`, `offset: Int`, `limit: Int`	`[VectorEntry]`	Paginated vector entries
`usageMetrics`	`projectId: String!`, `vectorSpaceId: Long!`, `year: Int`, `month: Int`	`UsageMetrics`	Usage metrics for a vector space
`search`	`projectId: String!`, `id: Long!`, `modality: String!`, `topK: Int!`, `query: String!`	`[SearchResult]`	Semantic search across a vector space. The `id` parameter is the vector space ID.
`listVectoTokens`	`projectId: String!`	`[VectoToken]`	List API tokens for vector operations
`listModels`	`projectId: String!`	`[EmbeddingModel]`	List available embedding models

User

Query	Parameters	Return Type	Description
`whoAmI`	(none)	`User`	Current user profile with subscription info and trial status
`features`	(none)	`[String]`	List of feature flags enabled for the current user
`userPreference`	(none)	`UserPreference`	Current user preferences
`trialStatus`	(none)	`TrialStatus`	Current trial status and remaining time

Notifications

Query	Parameters	Return Type	Description
`notificationPreferences`	`projectId: String!`	`NotificationPreferences`	Get notification settings for a project

Tokens

Query	Parameters	Return Type	Description
`listPlatformTokens`	`projectId: String!`	`[PlatformToken]`	List all platform API tokens for a project

Billing

Query	Parameters	Return Type	Description
`pricingTableOptions`	(none)	`PricingTableOptions`	Get pricing table configuration
`listProducts`	(none)	`[Product]`	List available subscription products

Misc

Query	Parameters	Return Type	Description
`namespaceAvailable`	`namespace: String!`	`Boolean`	Check if a namespace is available (authenticated users)
`signupNamespaceAvailable`	`namespace: String!`	`Boolean`	Check if a namespace is available (during signup, no auth)
`userId`	`email: String!`	`String`	Look up a user ID by email address
`untouched`	`projectId: String!`	`Boolean`	Check if a project is still in its initial state (e.g., used for onboarding flows to determine whether to show setup wizards)

Return Type Definitions

The return types referenced above (e.g., Agent, Project, VectorSpace) are defined in the GraphQL schema but are not yet individually documented here. Use your GraphQL client's introspection feature or run an introspection query to explore the full schema:

{
  __type(name: "Agent") {
    fields {
      name
      type { name kind }
    }
  }
}

Agents​

Templates​

Services​

Jobs​

Skills & Procedures​

Projects​

Workspaces​

Xircuits​

Data / Vector​

User​

Notifications​

Tokens​

Billing​

Misc​