Skip to main content
View as Markdown

Getting started

The Altium 365 API is a GraphQL API for reading and writing Altium 365 workspace data. This page gets you from an access token to a first successful query. Registering an application and obtaining a token are covered by the Altium Developer Center.

Endpoints​

The API is served per region. Send requests to the endpoint of the region that hosts your workspace:

RegionEndpoint
Europehttps://eur.365.altium.com/api/graphql
US Westhttps://usw.365.altium.com/api/graphql
US Easthttps://use.365.altium.com/api/graphql
Asia Pacifichttps://asp.365.altium.com/api/graphql
GovCloudhttps://use.365-gov.altium.com/api/graphql

Each workspace also has its own endpoint, https://{workspace-domain}/api/graphql, where {workspace-domain} is the host name of your workspace.

Authentication​

Every request carries an access token in the Authorization header:

Authorization: Bearer {access-token}

See Using an Access Token in the Developer Center for how access tokens are obtained, how long they last and how to renew them.

A first query​

List the workspaces the token's user can access, with the API endpoint that serves each of them:

query MyWorkspaces {
  desWorkspaceInfos {
    name
    url
    location {
      name
      apiServiceUrl
    }
  }
}

With curl:

curl https://eur.365.altium.com/api/graphql \
  -H "Authorization: Bearer $ALTIUM_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"query":"query MyWorkspaces { desWorkspaceInfos { name url location { name apiServiceUrl } } }"}'

The response is a JSON object with a data member (and an errors member if something went wrong, see Errors). Reference: desWorkspaceInfos.

Tools​

  • Nitro — an in-browser GraphQL IDE with schema-aware completion: https://{workspace-domain}/api/graphql/.
  • Voyager — an interactive graph of the schema: https://{workspace-domain}/api/voyager/.

Next steps​

For AI assistants​

Point your coding assistant at llms.txt. It lists every bounded context with its own llms.txt index and a compact schema.graphql slice, and every page of this site is also available as Markdown (append .md to the page URL).


Comments​