> ## Documentation Index
> Fetch the complete documentation index at: https://docs.devtune.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get the Agent Picks catalogue

> Lists what the setup wizard in the app offers for saveAgentPicksSetup and saveAgentPicksJob: published categories with their active tools, the environments (one with category_ids only for those categories), and the agents with the models each accepts and whether the account’s Agent Picks plan includes it. An unpublished category or retired tool is refused with 400 invalid_setup or invalid_job. An account without Agent Picks gets 403. Requires the setup.read scope. Takes no query parameters.



## OpenAPI

````yaml /openapi.json get /projects/{projectId}/setup/catalogue/agent-picks
openapi: 3.1.0
info:
  title: DevTune API
  version: 2.0.0
  description: >-
    API for programmatic access to your AI visibility data, webhook
    subscriptions, and automation workflows. Use this API to integrate DevTune
    data into CI/CD pipelines, BI tools, AI agents, and operational systems.
servers:
  - url: https://devtune.ai/api/v2
    description: Production
security:
  - bearerAuth: []
paths:
  /projects/{projectId}/setup/catalogue/agent-picks:
    get:
      summary: Get the Agent Picks catalogue
      description: >-
        Lists what the setup wizard in the app offers for saveAgentPicksSetup
        and saveAgentPicksJob: published categories with their active tools, the
        environments (one with category_ids only for those categories), and the
        agents with the models each accepts and whether the account’s Agent
        Picks plan includes it. An unpublished category or retired tool is
        refused with 400 invalid_setup or invalid_job. An account without Agent
        Picks gets 403. Requires the setup.read scope. Takes no query
        parameters.
      operationId: getAgentPicksCatalogue
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: The catalogue
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/SetupAgentPicksCatalogue'
                  meta:
                    $ref: '#/components/schemas/Meta'
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/RateLimitExceededError'
components:
  schemas:
    SetupAgentPicksCatalogue:
      type: object
      additionalProperties: false
      required:
        - categories
        - environments
        - agents
        - max_competitor_tool_keys
        - max_agent_models
      properties:
        categories:
          type: array
          description: >-
            Published categories, by name. Their ids are the category_id
            saveAgentPicksSetup and the source_category_id saveAgentPicksJob
            accept.
          items:
            type: object
            additionalProperties: false
            required:
              - id
              - slug
              - name
              - tools
            properties:
              id:
                type: string
                format: uuid
              slug:
                type: string
              name:
                type: string
              tools:
                type: array
                description: >-
                  The category’s active tools, by display name: the tool_key and
                  competitor_tool_keys a setup in this category may name.
                items:
                  type: object
                  additionalProperties: false
                  required:
                    - tool_key
                    - display_name
                    - brand_domain
                  properties:
                    tool_key:
                      type: string
                    display_name:
                      type: string
                    brand_domain:
                      type:
                        - string
                        - 'null'
        environments:
          type: array
          description: >-
            The environments the setup wizard offers for environment_ids, by
            name. One with category_ids is valid only with those categories.
          items:
            type: object
            additionalProperties: false
            required:
              - id
              - name
              - framework
            properties:
              id:
                type: string
                format: uuid
              name:
                type: string
              framework:
                type:
                  - string
                  - 'null'
                description: null for an empty project.
              category_ids:
                type: array
                items:
                  type: string
                  format: uuid
                description: >-
                  Present only for an environment that runs in some categories:
                  the published categories it may be saved with. Absent means
                  every category.
        agents:
          type: array
          description: >-
            The agents a setup may test, each with the models agent_models
            accepts for it.
          items:
            type: object
            additionalProperties: false
            required:
              - agent
              - name
              - included_in_plan
              - models
            properties:
              agent:
                type: string
              name:
                type: string
              included_in_plan:
                type: boolean
                description: >-
                  false when the account’s Agent Picks plan does not include the
                  agent: saving it is refused with 403 agent_not_in_plan.
              models:
                type: array
                items:
                  type: string
        max_competitor_tool_keys:
          type: integer
          minimum: 1
          description: The most competitor_tool_keys a setup may save.
        max_agent_models:
          type: integer
          minimum: 1
          description: The most agent_models entries a setup may save.
    Meta:
      type: object
      properties:
        timestamp:
          type: string
          format: date-time
        projectId:
          type: string
          format: uuid
    Error:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
        reason:
          type: string
          description: >-
            Why the request was refused, for an error with more than one cause,
            such as a refused content-draft start.
        details:
          type: object
          additionalProperties: true
          description: >-
            Machine-readable facts about the refusal, such as shortfall_credits
            when an Agent Picks start is refused for insufficient_credits.
        status:
          type: integer
      required:
        - error
        - message
        - status
  responses:
    BadRequestError:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    UnauthorizedError:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ForbiddenError:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFoundError:
      description: Not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimitExceededError:
      description: Rate limit exceeded
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  headers:
    X-RateLimit-Limit:
      description: Maximum requests per window
      schema:
        type: integer
    X-RateLimit-Remaining:
      description: Requests remaining in current window
      schema:
        type: integer
    X-RateLimit-Reset:
      description: Unix timestamp when the window resets
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key with dtk_live_ prefix. Obtain it from API Keys in the account
        sidebar. New keys start with all supported scopes selected for the
        chosen project, and you can narrow them to specific read/write scopes as
        needed.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.