Installing the Sourcegraph GraphQL API

Generate an Access Token

To authenticate with the GraphQL API, you'll need an access token. Generate one on your Sourcegraph instance:

https://sourcegraph.example.com/user/settings/tokens

Test the API

Run a simple query to verify your installation. Use the following command to echo your username:

curl -H 'Authorization: token YOUR_TOKEN' \
-d '{"query": "query { currentUser { username } }"}' \
https://sourcegraph.example.com/.api/graphql

You should see a response like this:

{ "data": { "currentUser": { "username": "YOUR_USERNAME" } } }

Explore the API Console

Sourcegraph includes a built-in API console for writing queries and viewing documentation. Access it at:

https://sourcegraph.example.com/api/console

You can also test the API on the Sourcegraph.com API console.