The Visla Open API always returns a 200 HTTP status to indicate a successful connection. The code field in the API response determines the operation's status: 0 indicates success, and any other value indicates an error or exception. The code ranges from 0 to 23XXX, with 0 representing success, and values outside this range signifying different types of errors or exceptions. In case of success, the data property contains the expected results. For errors, the msg property provides a description of the issue.

Success Response Example

{
  "code": 0,
  "msg": "SUCCESS",
  "trackingId": "",
  "data": {}
}

Failure Response Example

{
  "code": 31010,
  "msg": "duplicate request",
  "trackingId": ""
}

Common Error Codes

Code	Message	Description	Category
0	SUCCESS	Request successful	Success
1000	Unknown error	Internal server error	Unknown
2000	Request method is not allowed	HTTP method not supported	Method Not Allowed
2100	This api is not supported any more or deprecated	API deprecated	Method Not Allowed
3000	Invalid request parameters	Request parameters are invalid	Invalid Arguments
3003	Missing required parameters	Required parameters not provided	Invalid Arguments
3004	Missing token	Authentication token missing	Invalid Arguments
3005	Invalid token	Authentication token invalid	Invalid Arguments
3006	Invalid email format	Email format is incorrect	Invalid Arguments
3008	Expired token	Authentication token expired	Invalid Arguments
3009	Invalid S3 URL format	S3 URL format is incorrect	Invalid Arguments
3010	Unsupported this file suffix, we just supported .	File format not supported	Invalid Arguments
3020	Unable to process project.	Project processing failed	Invalid Arguments
3042	We have not yet finished processing your assets.	Asset processing in progress	Invalid Arguments
3043	We encountered an error while processing the asset. Please try adding it again.	Asset processing failed	Invalid Arguments
3049	You've exceeded our system limit of 200 pages across PDFs, PPTs, and images. Please reduce the number of pages or images and try again.	File size/page limit exceeded	Invalid Arguments
4004	Project is not found	Project does not exist	Not Found
4009	Project asset is not found	Asset does not exist	Not Found
4060	The agent project media is not found.	Media not found in project	Not Found
4063	The agent project document is not found.	Document not found in project	Not Found
4600	Agent Project is not found	Agent project does not exist	Not Found
6000	Your account has been suspended.	Account disabled	Permission Denied
6001	Your account has not been activated. Please check the activation email in your inbox	Account not activated	Permission Denied
6002	Access denied	Insufficient permissions	Permission Denied
6025	You have a video being generated, please wait until the video generation process completes.	Generation in progress limit	Permission Denied
6050	Your account has run out of credits and is now locked. To resume tasks, please purchase additional credits or wait for the next billing cycle for your credits to refresh.	Insufficient credits	Permission Denied
6052	Insufficient credits to use this feature. Please purchase additional credits to continue.	Feature requires credits	Permission Denied
6200	This feature is not supported by your plan, please upgrade your plan to use it	Plan limitation	Permission Denied
6401	Open API access is not available: Your workspace is not on a paid plan. Please upgrade to a paid plan or contact your administrator for more details.	OpenAPI access denied	Permission Denied
7000	Your username or password is incorrect	Authentication failed	Unauthenticated
7004	Your access token was already revoked, please sign in again to refresh the token	Token revoked	Unauthenticated
14000	Internal server error	Server internal error	Internal Error
15000	Visla is currently undergoing maintenance. Please try again later.	Service maintenance	Service Unavailable
17001	API requests are too frequent, please try again later	Rate limit exceeded	Rate Limited
17002	API requests are too frequent, please try again later	IP rate limit exceeded	Rate Limited
23000	Storage failed	AWS S3 failure	Third Party Error
23004	Video editing server error	Video processing failure	Third Party Error
31001	apikey is required	API key missing	OpenAPI Error
31002	apikey is invalid	API key invalid	OpenAPI Error
31003	apikey not exists	API key not found	OpenAPI Error
31005	sign is invalid	Signature invalid	OpenAPI Error
31006	ts is invalid	Timestamp invalid	OpenAPI Error
31010	duplicate request	Request already processed	OpenAPI Error
31020	required param missed	Required parameter missing	OpenAPI Error
31021	The apikey does not have permission to access this resource	API key permission denied	OpenAPI Error
31030	client ip is not in the allow list	IP not whitelisted	OpenAPI Error