Get Service Info
Request
This API allows you to fetch informations about a service identified by a service_id.
The API requires making a GET request by specifying the service_id as a parameter as the examples below shows .
curl --location 'https://platform.mybiros.com/api/v1/inference/service/:service_id:' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Accept: application/json'
Note
The service_fields field of the response is akin to the field with the same name included in
the inference responses, see service_fields for further information.
Responses
Successful Responses
The request was successful, and a JSON response is returned.
| Status | Message | Description | Reference |
|---|---|---|---|
| 200 | OK | the request has succeeded. | Success Response 200 |
Status 200 - OK
JSON Response Example
{
"service_id": "<service-id>",
"name": "Example Service",
"description": "This is an example service.",
"service_fields": {
"id_number_1": {
"tag_alias": "IdNumber",
"tag_multiple_values": true,
"tag_aggregation": null
},
"issue_date_1": {
"tag_alias": "IssueDate",
"tag_multiple_values": false,
"tag_aggregation": null
},
"purchase_line_1": {
"tag_alias": "PurchaseLine",
"tag_multiple_values": true,
"tag_aggregation": {
"aggregation_fields": [
"id_number_3",
"id_number_4",
"id_number_5"
]
}
}
},
"created_at": "2024-09-09T14:55:31.261000"
}
Schema: Service Info
| Key | Type | Description |
|---|---|---|
| service_id | string | the service identifier |
| name | string | the service name |
| description | string | the service description |
| services_fields | object | a JSON object containing info about service fields |
| created_at | string | datetime of when service has been created in ISO 8601 format |
Service Fields Deep Dive
For more information about service_fields object visit Service Fields Object
Error Responses
The request was unsuccessful, and a specific status code is returned to identify the error.
| Status | Message | Description | Reference |
|---|---|---|---|
| 401 | Unauthorized | the server has not been able to authenticate the request. | Response 401 |
| 404 | Not Found | the server could not locate the requested resource. | Response 404 |
| 429 | Too Many Requests | the client has sent too many requests in a short period, exceeding the rate limit. Please try again later. | Response 429 |
| 500 | Internal Server Error | the server encountered an unexpected and unrecoverable error while processing the request. | Response 500 |
| 503 | Service Unavailable | the server could be under maintenance for an update. Will be back soon. | Response 503 |
Status 401 - Unauthorized
The current endpoint is protected and requires an API key to be accessed. If sufficient privileges are not present, the request will not be authorized.
Tip
Double-check that the API Key is correct, valid and set using the x-api-key header
in the request. Also make sure that you are using the right API key for the service
you are requesting and that the service ID in it is correct and corresponds to the ID of
an existing service in your account.
Status 404 - Not Found
The service ID provided does not exist or could not be found. Please verify the ID and try again.
Status 429 - Too Many Requests
This status code is returned when the client has made too many requests in a given timeframe, exceeding the rate limits set by the server. It indicates that the client needs to slow down and retry after a specified cooldown period. Rate limits are typically enforced to protect the server from being overwhelmed and to ensure fair use of resources.
Status 500 - Internal Server Error
This status code indicates that the server encountered an unexpected error or condition that prevented it from completing the request. It is a generic error message when no more specific message is suitable. The client cannot resolve the issue.
Status 503 - Service Unavailable
This status code indicates that the server is currently unavailable, typically due to ongoing maintenance or temporary overloading. The server is unable to handle the request at the moment, but the issue is expected to be resolved shortly. This status code signals that the downtime is temporary, and the service will be restored once maintenance is complete.