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

# Surface map

> Every REST endpoint at a glance, grouped by resource.

Every endpoint in the REST API, grouped by resource. See [Introduction](/api-reference/introduction) for the base URL and authentication.

<div className="surface-map surface-map--method">
  ## Async Jobs

  | Endpoint                                             | Method                                         |
  | ---------------------------------------------------- | ---------------------------------------------- |
  | [Get async job status](/api-reference/get-async-job) | <span className="method method-get">GET</span> |

  ## Chat

  | Endpoint                                                        | Method                                           |
  | --------------------------------------------------------------- | ------------------------------------------------ |
  | [Create chat completion](/api-reference/create-chat-completion) | <span className="method method-post">POST</span> |
  | [Materialize an API chat](/api-reference/materialize-chat)      | <span className="method method-post">POST</span> |
  | [Search chats](/api-reference/search-chats)                     | <span className="method method-get">GET</span>   |

  ## Files

  | Endpoint                                                    | Method                                               |
  | ----------------------------------------------------------- | ---------------------------------------------------- |
  | [Upload a file](/api-reference/upload-file)                 | <span className="method method-post">POST</span>     |
  | [Search files](/api-reference/search-files)                 | <span className="method method-get">GET</span>       |
  | [Get file status](/api-reference/get-file-status)           | <span className="method method-get">GET</span>       |
  | [Move a file](/api-reference/update-file)                   | <span className="method method-patch">PATCH</span>   |
  | [Initiate a chunked upload](/api-reference/initiate-upload) | <span className="method method-post">POST</span>     |
  | [Upload a file part](/api-reference/upload-part)            | <span className="method method-put">PUT</span>       |
  | [Complete a chunked upload](/api-reference/complete-upload) | <span className="method method-post">POST</span>     |
  | [Abort a chunked upload](/api-reference/abort-upload)       | <span className="method method-delete">DELETE</span> |

  ## Folders

  | Endpoint                                                        | Method                                               |
  | --------------------------------------------------------------- | ---------------------------------------------------- |
  | [List folders](/api-reference/list-folders)                     | <span className="method method-get">GET</span>       |
  | [Create a folder](/api-reference/create-folder)                 | <span className="method method-post">POST</span>     |
  | [Get a folder](/api-reference/get-folder)                       | <span className="method method-get">GET</span>       |
  | [Update a folder](/api-reference/update-folder)                 | <span className="method method-patch">PATCH</span>   |
  | [Delete a folder](/api-reference/delete-folder)                 | <span className="method method-delete">DELETE</span> |
  | [List a folder's children](/api-reference/list-folder-children) | <span className="method method-get">GET</span>       |

  ## Playbooks

  | Endpoint                                                               | Method                                               |
  | ---------------------------------------------------------------------- | ---------------------------------------------------- |
  | [List playbooks](/api-reference/list-playbooks)                        | <span className="method method-get">GET</span>       |
  | [Create a playbook](/api-reference/create-playbook)                    | <span className="method method-post">POST</span>     |
  | [Get a playbook](/api-reference/get-playbook)                          | <span className="method method-get">GET</span>       |
  | [Update a playbook](/api-reference/update-playbook)                    | <span className="method method-patch">PATCH</span>   |
  | [Delete a playbook](/api-reference/delete-playbook)                    | <span className="method method-delete">DELETE</span> |
  | [Duplicate a playbook](/api-reference/duplicate-playbook)              | <span className="method method-post">POST</span>     |
  | [Run a playbook against uploaded files](/api-reference/run-playbook)   | <span className="method method-post">POST</span>     |
  | [List a playbook's checks](/api-reference/list-playbook-checks)        | <span className="method method-get">GET</span>       |
  | [Add a check to a playbook](/api-reference/create-playbook-check)      | <span className="method method-post">POST</span>     |
  | [Get a check](/api-reference/get-playbook-check)                       | <span className="method method-get">GET</span>       |
  | [Update a check](/api-reference/update-playbook-check)                 | <span className="method method-patch">PATCH</span>   |
  | [Remove a check from a playbook](/api-reference/delete-playbook-check) | <span className="method method-delete">DELETE</span> |
  | [Reorder a playbook's checks](/api-reference/reorder-playbook-checks)  | <span className="method method-post">POST</span>     |

  ## Profiles

  | Endpoint                                                            | Method                                             |
  | ------------------------------------------------------------------- | -------------------------------------------------- |
  | [Identify the caller](/api-reference/get-me)                        | <span className="method method-get">GET</span>     |
  | [Get your personal profile](/api-reference/get-my-profile)          | <span className="method method-get">GET</span>     |
  | [Update your personal profile](/api-reference/update-my-profile)    | <span className="method method-patch">PATCH</span> |
  | [Get the company profile](/api-reference/get-company-profile)       | <span className="method method-get">GET</span>     |
  | [Update the company profile](/api-reference/update-company-profile) | <span className="method method-patch">PATCH</span> |

  ## Projects

  | Endpoint                                                                    | Method                                               |
  | --------------------------------------------------------------------------- | ---------------------------------------------------- |
  | [List projects](/api-reference/list-projects)                               | <span className="method method-get">GET</span>       |
  | [Create a project](/api-reference/create-project)                           | <span className="method method-post">POST</span>     |
  | [Get a project](/api-reference/get-project)                                 | <span className="method method-get">GET</span>       |
  | [Update a project](/api-reference/update-project)                           | <span className="method method-patch">PATCH</span>   |
  | [Delete a project](/api-reference/delete-project)                           | <span className="method method-delete">DELETE</span> |
  | [Attach a file to a project](/api-reference/attach-file-to-project)         | <span className="method method-post">POST</span>     |
  | [List files on a project](/api-reference/list-project-files)                | <span className="method method-get">GET</span>       |
  | [Detach a file from a project](/api-reference/detach-file-from-project)     | <span className="method method-delete">DELETE</span> |
  | [List folders linked to a project](/api-reference/list-project-folders)     | <span className="method method-get">GET</span>       |
  | [Attach a folder to a project](/api-reference/attach-folder-to-project)     | <span className="method method-post">POST</span>     |
  | [Detach a folder from a project](/api-reference/detach-folder-from-project) | <span className="method method-delete">DELETE</span> |
  | [Star a project](/api-reference/star-project)                               | <span className="method method-post">POST</span>     |
  | [Unstar a project](/api-reference/unstar-project)                           | <span className="method method-delete">DELETE</span> |
  | [List chats in a project](/api-reference/list-project-chats)                | <span className="method method-get">GET</span>       |
  | [File a chat into a project](/api-reference/attach-chat-to-project)         | <span className="method method-post">POST</span>     |

  ## Skills

  | Endpoint                                      | Method                                               |
  | --------------------------------------------- | ---------------------------------------------------- |
  | [List skills](/api-reference/list-skills)     | <span className="method method-get">GET</span>       |
  | [Create a skill](/api-reference/create-skill) | <span className="method method-post">POST</span>     |
  | [Get a skill](/api-reference/get-skill)       | <span className="method method-get">GET</span>       |
  | [Update a skill](/api-reference/update-skill) | <span className="method method-patch">PATCH</span>   |
  | [Delete a skill](/api-reference/delete-skill) | <span className="method method-delete">DELETE</span> |

  ## Usage

  | Endpoint                                            | Method                                         |
  | --------------------------------------------------- | ---------------------------------------------- |
  | [Get credit usage](/api-reference/get-credit-usage) | <span className="method method-get">GET</span> |
  | [Get usage summary](/api-reference/get-usage)       | <span className="method method-get">GET</span> |

  ## Utility

  | Endpoint                            | Method                                         |
  | ----------------------------------- | ---------------------------------------------- |
  | [Health check](/api-reference/ping) | <span className="method method-get">GET</span> |
</div>
