Skip to main content

Finite State API

The Finite State platform provides interactive API documentation that allows you to explore and test API endpoints directly within your Finite State instance.

Accessing the API Documentation​

The interactive API docs (Swagger UI) are accessible within your Finite State instance at:

https://[org].finitestate.io/swagger

Replace [org] with your organization's subdomain. For example, if your organization is "acme", the API documentation would be available at https://acme.finitestate.io/swagger.

API Authentication​

To use the API, you need to create an API token. API tokens are scoped to your user account and provide secure access to the Finite State platform.

For detailed instructions on creating and managing API tokens, see the API Tokens documentation.

Getting Started​

  1. Access the API documentation at your organization's Swagger URL
  2. Create an API token following the instructions in the API Tokens guide
  3. Authenticate your requests using your API token in the Authorization header
  4. Explore the available endpoints using the interactive documentation

The interactive API documentation provides detailed information about:

  • Available endpoints and HTTP methods
  • Request and response schemas
  • Required and optional parameters
  • Example requests and responses
  • Authentication requirements

Need Help?​

If you need assistance with the API or have questions about specific endpoints, please contact Finite State Support.