How to Connect Describely to Your PIM or Sales Platform with API

In this article

• Generate your API key
• Explore the API documentation
• Make your first API call
• Understand token usage and pricing
• Manage access and security

Generate your API key

1. On the bottom left of Describely, click Account > Business Settings > Security & Access.
2. Under API Keys, click Create API Key.
3. Copy the key immediately—it's only visible once for security reasons.
4. Store it somewhere safe (like a password manager).

Explore the API documentation

Describely’s API documentation is hosted on the ReadMe platform for easy testing and exploration.

To access it:

1. From Describely's Account Business Settings, click into the <> Developer tab.
2. Scroll to the bottom and open the Full Documentation URL.
3. Paste your API key into the header field on the right (example: ds-xxxxxx ).

You’ll see all available endpoints, including:

• Product CRUD Operations: Create, read, update, or delete products.
• Catalog Access: Retrieve or modify catalog data.
• Ruleset Access: Apply your content rulesets from Describely.
• Content Generation: Generate copy for fields configured in Describely only (e.g., product title,  description, bullet points).

Make your first API call

Once your key is ready, you can start testing endpoints directly from the documentation interface.

1. Under Products, select List Products to retrieve a sample of your catalog.
2. Choose Create Product to test adding a new product.
3. Input your payload in JSON format and click Send Request.

You’ll immediately see the response—successful calls will return product data from your account.

Understand token usage and pricing

Describely uses a pay-per-token model for API usage, separate from the in-app product credit balance.

• Pricing: $0.20 per 1,000 tokens
• Average cost per product generation: 1,000–3,000 tokens
• Billing: API tokens are tracked and billed separately from other credit activity in Describely.

To monitor usage, open Plans from your Account settings. You’ll see remaining token credits in real time.

Manage access and security

API keys are linked to your organization and have access to your Describely business data.

• Treat them like passwords. Rotate keys regularly.
• Only share keys with trusted developers or system integrators.
• Revoke a key immediately if you suspect unauthorized use.

For production deployments, store keys as environment variables rather than hardcoding them into scripts or apps.