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/repository/{workspace}/{repository}/execute-rule
Parameters
post
https://api.specifyapp.com/v2/repository/{workspace}/{repository}/execute-rule
Get tokens graph
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"
            }
        }
    ]
}'
Commands
Pull
Pull design tokens and assets from your Specify repository.
specify pull

to-style-dictionary

Last modified 26d ago