REST API

The Specify API lets you extend Specify functionalities beyond what we provide out of the box.

New to Specify? Head over to the existing REST API documentation to learn more about why it can be useful for your team and how to use it.

Endpoint

Specify provides the following endpoint to help you get design tokens and assets from a Specify repository.

https://api.specifyapp.com/v2/{workspace}/repository/{repository}/execute-rule

Parameters

Get tokens graph

POST https://api.specifyapp.com/v2/{workspace}/repository/{repository}/execute-rule

Get design tokens and assets from a Specify repository. You can only execute a single rule with this endpoint.

Path Parameters

Name	Type	Description
workspace*	String	The name of your organization in Specify. For instance, in this URL https://specifyapp.com/ @specifyapp/Seeds the workspace is "@specifyapp".
name	String	The name of the Specify repository containing the design data you're requesting. For instance, in this URL https://specifyapp.com / @specifyapp/Seeds the repository is "Seeds".

Request Body

Name	Type	Description
parsers*	Object or Array	Can contain an object or an array of objects. Each object corresponds to a specific parser.
name*		The name of your rule

200: OK Everything worked as expected.

401: Unauthorized No valid API key provided.

403: Forbidden

404: Not Found

500: Internal Server Error Something went wrong on Specify

Once you have your personal access token, you can pass it within the Authorization header of your request.

Example

Here's a simple example to get tokens in JSON from a repository called all-design-datain the @acme-inc workspace:

curl -X POST 'https://api.specifyapp.com/v2/@acme-inc/repository/all-design-data/execute-rule' \
--header 'Authorization: <your-personal-access-token>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "SDTF",
    "parsers": [
        {
            "name": "as-is",
            "output": {
                "type": "file",
                "filePath": "tokens.json"
            }
        }
    ]
}'