assistant

assistant {
   assistantID: String!
}: Assistant

Retrieve an assistant

Permissions needed

select (assistants):

• id
• assistantID

Arguments

• assistantID (String!): ID of the assistant to retrieve

Response

Type: Assistant

• assistantID (String!): ID of the assistant

• name (String!): Name of the assistant

• description (String!): Description of the assistant

• instructions (String!): Instructions for the assistant. This is used to instruct the AI assistant on how to behave and respond to the user

• model (String!): Model to use for the assistant.

• graphql ([AssistantToolGraphQL!]): GraphQL data sources and tools. Run against the project’s GraphQL API

properties

• name (String!): Name of the data source

• description (String!): Description of the data source

• query (String!): GraphQL query to run against the project’s GraphQL API.

• arguments ([AssistantToolArgument!]!): Arguments to pass to the GraphQL query

properties

• name (String!):

• description (String!):

• type (String!):

• required (Boolean!):

• webhooks ([AssistantToolWebhook!]): Webhook data sources and tools

properties

• name (String!): Name of the data source

• description (String!): Description of the data source

• URL (String!): URL of the webhook

• arguments ([AssistantToolArgument!]!): Arguments to pass to the webhook

properties

• name (String!):

• description (String!):

• type (String!):

• required (Boolean!):

Request Example:

query assistant (
  $assistantID: String!
) {
  graphite {
    assistant (
      assistantID: $assistantID
    ) {
      assistantID
      name
      description
      instructions
      model
      graphql {
        name
        description
        query
        arguments {
          name
          description
          type
          required
          }
        }
      webhooks {
        name
        description
        URL
        arguments {
          name
          description
          type
          required
          }
        }
    }
  }
}

{
  "assistantID": "string"
}

Response Example:

{
  "data": {
    "graphite": {
      "assistant": {
        "assistantID": "string",
        "description": "string",
        "graphql": [
          {
            "arguments": [
              {
                "description": "string",
                "name": "string",
                "required": true,
                "type": "string"
              }
            ],
            "description": "string",
            "name": "string",
            "query": "string"
          }
        ],
        "instructions": "string",
        "model": "string",
        "name": "string",
        "webhooks": [
          {
            "URL": "string",
            "arguments": [
              {
                "description": "string",
                "name": "string",
                "required": true,
                "type": "string"
              }
            ],
            "description": "string",
            "name": "string"
          }
        ]
      }
    }
  }
}