About the Verodat API
The Verodat API enables users to execute a query against a database via an API endpoint. It allows for the management of queries, and retrieval of results, in a variety of different coding languauges.
Key Features:
The Verodat API has the following capabilities:
Submitting SQL Statements: Execute SELECT statements only.
Authentication: Uses token-based authentication.
Executes within popular LLM models: Includes metadata context, entity diagram and validation information to train LLM models.
Error Handling: Retrieve detailed error information.
Response Size: There is no limit to maximum size of a response that can be returned.
Limitations:
The Verodat API has a few limitations:
Single Requests: Executes a single statement per request.
Rate Limits: There are limits on the number of API requests that can be made within a specific timeframe.
Timeouts: The API has a 60 min timeout for SQL execution; long-running queries may need to be broken into smaller queries.
Authentication Details:
The Verodat API employs token-based authentication to secure API requests. This guide outlines the necessary steps for users to authenticate and interact with the API.
Users must initially authenticate by calling the signin API endpoint with their username and password. Upon successful authentication, the API will return an access token and a refresh token.
Access tokens have a limited lifespan. When an access token expires, users must obtain a new one by making a POST request to the access token endpoint.
More information on authentication in our developer guide.
Error Handling Details:
The Verodat API has a robust error-handling mechanism to provide clear and consistent responses for various exceptions. There are a number of types of exceptions handled and the corresponding HTTP status codes returned by the API, which can be viewed in our developer guide.
Below are the key points for error handling:
Default Response Format: All error responses are formatted as JSON.
HTTP Status Codes: Specific HTTP status codes are associated with different types of exceptions.
Localized Error Messages: Error messages are localized based on the user's locale. It is handled at many places but not all the places. When It is not handle , English language message would be displayed.
More information on error handling in our developer guide.
More information:
For more details, visit the Verodat Developer Documentation.
Response Sample:
{
"header": [
{
"column": "SUPPLIER_ID",
"typeName": "NUMBER",
"type": -5
},
{
"column": "COMPANY_NAME",
"typeName": "VARCHAR",
"type": 12
},
{
"column": "CONTACT_NAME",
"typeName": "VARCHAR",
"type": 12
},
{
"column": "CONTACT_TITLE",
"typeName": "VARCHAR",
"type": 12
},
{
"column": "ADDRESS",
"typeName": "VARCHAR",
"type": 12
},
{
"column": "CITY",
"typeName": "VARCHAR",
"type": 12
},
{
"column": "REGION",
"typeName": "VARCHAR",
"type": 12
},
{
"column": "POSTAL_CODE",
"typeName": "VARCHAR",
"type": 12
},
{
"column": "COUNTRY",
"typeName": "VARCHAR",
"type": 12
},
{
"column": "PHONE",
"typeName": "VARCHAR",
"type": 12
},
{
"column": "FAX",
"typeName": "VARCHAR",
"type": 12
},
{
"column": "HOME_PAGE",
"typeName": "VARCHAR",
"type": 12
},
{
"column": "G360_FINGERPRINT",
"typeName": "VARCHAR",
"type": 12
},
{
"column": "G360_VERSION_NUMBER",
"typeName": "NUMBER",
"type": -5
},
{
"column": "G360_DATE_CREATED",
"typeName": "TIMESTAMPNTZ",
"type": 93
},
{
"column": "G360_DATE_UPDATED",
"typeName": "TIMESTAMPNTZ",
"type": 93
}
],
"data": [
[
1,
"Exotic Liquids",
"Charlotte Cooper",
"Purchasing Manager",
"49 Gilbert St.",
"London",
null,
"EC1 4SD",
"UK",
"(171) 555-2222",
"6143.1",
1,
"2024-07-09T11:31:27Z"
],
[
2,
"New Orleans Cajun Delights",
"Shelley Burke",
"Order Administrator",
"P.O. Box 78934",
"New Orleans",
"LA",
"70117",
"USA",
"(100) 555-4822",
null,
"#CAJUN.HTM#",
"6143.2",
1,
"2024-07-09T11:31:27Z"
],
[
3,
"Grandma Kelly's Homestead",
"Regina Murphy",
"Sales Representative",
"707 Oxford Rd.",
"Ann Arbor",
"MI",
"48104",
"USA",
"(313) 555-5735",
"(313) 555-3349",
null,
"6143.3",
1,
"2024-07-09T11:31:27Z"
],
[
4,
"Tokyo Traders",
"Yoshi Nagase",
"Marketing Manager",
"9-8 Sekimai Musashino-shi",
"Tokyo",
null,
"100",
"Japan",
"(03) 3555-5011",
"6143.4",
1,
"2024-07-09T11:31:27Z"
],
]
}