Authentication
Every conversion request call must be authenticated with your credentials. ConvertAPI supports Query Parameters and Bearer Authentication for stateless authentication.
Authentication keys
You have two options for authenticating your requests, which can be found in your account dashboard:
- API Key: Authenticates conversion requests, differentiates environments, and sets consumption limits.
- JWT Token: You can either self-sign it or use our JWT Generator endpoint.
Authentication methods
You can pass your preferred authentication key using the Authorization header:
| Method | Persistence | Usage |
|---|---|---|
| Bearer Authentication | Stateless | Jwt Token, API Token |
Authorization header
Authenticate your API calls using API Secret or API Token as a Bearer token using the Authorization header:
curl -X POST https://v2.convertapi.com/convert/docx/to/pdf \
-H "Authorization: Bearer secret_or_token"
-F "File=@/path/to/my_file.docx" \
-F "StoreFile=true" Authentication Response Codes
- 200 OK
- 401 Unauthorized
4010: Invalid user credentials - bad secret.4011: Invalid user credentials - bad token.4013: User credentials not set - secret or token must be provided.4014: User inactive.
Updated 12 days ago