{ "opencollection": "1.0.0", "info": { "name": "Bird FAQ API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "FAQ", "type": "folder" }, "items": [ { "info": { "name": "List datasets", "type": "http" }, "http": { "method": "GET", "url": "https://faq.messagebird.com/api/v1/datasets", "params": [ { "name": "listMode", "value": "", "type": "query", "description": "The list mode indicating which datasets to query." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of datasets to return." }, { "name": "cursor", "value": "", "type": "query", "description": "The cursor to view the next paginated collection of datasets." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Lists datasets containing answers and corresponding questions. You can choose to list only your own datasets, template datasets, or both. Results may be paginated.\n" }, { "info": { "name": "Get dataset", "type": "http" }, "http": { "method": "GET", "url": "https://faq.messagebird.com/api/v1/datasets/:datasetId", "params": [ { "name": "datasetId", "value": "", "type": "path", "description": "The unique ID for the dataset." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieves the dataset for the given dataset ID." }, { "info": { "name": "Predict answer", "type": "http" }, "http": { "method": "POST", "url": "https://faq.messagebird.com/api/v1/datasets/:datasetId/predict-answer", "params": [ { "name": "datasetId", "value": "", "type": "path", "description": "The unique ID that identifies the dataset for which a question should be answered." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Predicts an answer corresponding to a question which is possibly contained in the given phrase. The FAQ API uses machine learning to generalize from the questions and answers in the dataset to infer the answer. Requires the active model to be trained (usually ~1 minute after dataset creation or update).\n" }, { "info": { "name": "Get supported languages", "type": "http" }, "http": { "method": "GET", "url": "https://faq.messagebird.com/api/v1/supported-languages", "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Lists the languages supported by the FAQ API." } ] } ], "bundled": true }