Skip to main content

Authentication

How to obtain and use an API Key

The ParseX API uses Alibaba Cloud Model Studio API Key authentication. Requests carry the API Key in the Authorization header.

Obtain credentials

  1. Open the console Open the Model Studio console and log in with your Alibaba Cloud account.
  2. Get the API Key Obtain the DASHSCOPE_API_KEY in the console; it starts with sk-. For details, see Get an API Key.
    An API Key has account-level permissions. Keep it secure — do not share it through public channels or commit it to a code repository.

Usage

Configure the API Key as an environment variable:
export DASHSCOPE_API_KEY="sk-xxxxxxxxxxxxxxxx"
Include the Authorization header in every request:
curl https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v2/apps/parse-x/parse/submit \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Content-Type: application/json"

Permissions

  • Alibaba Cloud primary account: can call all endpoints directly
  • RAM user: must be granted the required permissions before calling
  • The permission scope of an API Key is configured in the console

Security recommendations

  • Keep it out of code repositories: store the API Key in environment variables
  • Use separate keys per application: give each application its own API Key to simplify tracking and revocation
  • Rotate regularly: replace API Keys periodically to reduce the risk of leakage
Once your credentials are ready, see Submit a parsing task to start calling the API.
Managed Agent API
Flow Agent API
Sandbox API
RAG API
Long-term Memory
ParseX API
Security API
Framework Integration