Quick start¶

The AtomGit API gives you programmatic access to resources on AtomGit. This guide explains how to use it: valid API requests, authentication, status codes, pagination, path parameters, and more.

For AI agents and automation¶

If you are an AI agent or an automation tool, read the following resources in order instead of parsing the rendered HTML page by page:

• AtomGit API index and summary (llms.txt): an index of the name, description, and documentation link for every endpoint. Read this file first when you are looking for an endpoint.
• AtomGit API JSON specification: the complete machine-readable API specification (OpenAPI 3.0.3). Read this file when you build request parameters or integrate the API into a tool.
• AtomGit API Markdown version of the same specification: the complete machine-readable specification in Markdown. Use this URL when you want to feed the specification to an agent.

API hosts and multiple domains¶

The AtomGit API is served from several domains with identical functionality and endpoints, so you can pick the one closest to your network:

Requests to both hosts share the same paths, parameters, authentication, and response structure, so you can switch hosts without changing any code. For example, the following two requests are equivalent:

curl "https://api.atomgit.com/api/v5/users/{username}"

curl "https://api.gitcode.com/api/v5/users/{username}"

Note: examples in this documentation use https://api.atomgit.com. If you use the GitCode domain, only the host part changes. We recommend storing the host in an environment variable so it is easy to switch and migrate.

Making your first request¶

1. Create a token on the personal access token page.

2. Save the token as an environment variable:

   export ATOMGIT_TOKEN=<your-token>
   

3. Look up a public user profile. This endpoint does not require authentication:

   curl 'https://api.atomgit.com/api/v5/users/<username>'
   

4. List the open issues in a repository:

   curl 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/issues?state=open&per_page=20' \
     -H "Authorization: Bearer $ATOMGIT_TOKEN"