Skip to main content

​
What it is

This page explains which environments you can use the API in, how to find out about changes that affect your integration, and how to get help from the Symphony team.

​
Environments

​
Testing your integration

There’s no open test environment (sandbox). In most cases, you can develop directly in production, with a few precautions:
  • Ask your company’s administrator for a dedicated technical account. That way test usage stays separate from your personal usage, and the administrator can set a low usage limit for that account.
  • Use cheaper models while developing and switch to the final model only at the end.
  • Limit volume. Test batches with a few items before running the full process.
  • Track usage with GET /api/v1/consumption/me.

​
When to request staging access

Request HML access when you need to:
  • test an integration that may generate high volume or cost before releasing it in production;
  • validate your integration against a Symphony version that hasn’t reached production yet.
HML has a copy of some of what exists in production, but not all of it. Before testing, check that your API key, your X-Enterprise-Id, and the models and agents you’ll use exist in HML.

​
How to request HML access

HML access is granted on request and only to FCamara employees. To request it, contact the Symphony team on WhatsApp or by email at symphony@fcamara.com.

​
API changes

​
Symphony version

To find out which version is running in an environment:
What’s new in each version is published in Releases.

​
What’s stable

The API doesn’t have its own version numbers. The v1 that appears in some paths (/api/v1/...) is part of the address and doesn’t change with each Symphony version. To keep your integration working over time:
  • Use only the endpoints in the API reference. Endpoints outside it are internal and may change without notice.
  • Ignore fields you don’t recognize in responses. New fields can be added at any time, and that isn’t considered a breaking change.
  • Handle errors by code, never by message text (see Errors and limits).
  • Don’t hard-code model IDs. Read the model from configuration and validate it with GET /api/models at startup. The catalog is managed by your company and can change.

​
Support

​
Before opening a ticket

1

Check the quickstart

See Most common issues when starting out in Connect via API. Most early problems are the key or X-Enterprise-Id.
2

Look up the error code

Check the code catalog in Errors and limits.
3

Confirm permissions and limit

Check with your company’s administrator that your account has the required permission and usage limit.

​
Who to contact

Contact the Symphony team on WhatsApp or by email at symphony@fcamara.com.

​
What to send in the ticket

  • The request_id from the error response.
  • The environment (production or HML).
  • The endpoint, the approximate time, and the time zone.
  • The HTTP status and the error code.
  • The request body, without the API key.
Never send your API key, not in a ticket, an email, or a screenshot. If it leaks, generate a new one right away in Settings → Account → API keys.