OpenAPI specification

The file

The API is described as OpenAPI 3.1, at a public URL. You do not need a key to read it, so you and your tools can look before you sign up.

https://www.skipshoot.com/api/v1/openapi.json

Open the file

Import into Postman or Insomnia

1. Import the URL

   In Postman choose Import, or in Insomnia Import from URL, and paste the address above. Every endpoint arrives as a request, with its parameters.

2. Add your key

   Set the collection’s authorization to Bearer Token and paste your secret key into a secret variable, not into each request. See Authentication.

3. Send a first request

   Start with Retrieve your account, which spends nothing and shows that the key works.

Generate a client

There is no official SDK. Any OpenAPI generator can make a typed client in your own language from the file. For example, with the OpenAPI Generator command line tool:

npx @openapitools/openapi-generator-cli generate \
  -i https://www.skipshoot.com/api/v1/openapi.json \
  -g typescript-fetch \
  -o ./skipshoot-client

Swap typescript-fetch for python, java, go, csharp or any other generator it supports.

What it covers

The file describes every endpoint in the API reference, with request bodies, responses and the error object. These pages add what a description file cannot say well: how the pieces fit together, the render lifecycle, and how to handle limits and retries.