All API requests must be directed to the following base endpoint: https://api.chathive.app
\nTo authenticate your requests, you must include your API key in the request header:
\n| Header | Value |
| x-api-key | YOUR_API_KEY |
You can create, rotate, and manage your API keys directly from your Chathive dashboard.
\n200 OK: The request was successfully
201 Created: The resource was successfully created
202 Accepted: The request was accepted for processing
204 No Content: The request was successfully but does not return anything
400 Bad request: The endpoint was called using invalid data
401 Unauthorized: The API key is missing, invalid, or lacks necessary permissions.
404 Resource not found: Make sure the correct URL was used
429 Too many requests: See Rate limits for more inforation
500 Internal Server Error: An unexpected error occurred. Contact support if this problem keeps occurring.
Rate limiting is enforced per API key using a sliding window.
\nStandard Limit: 512 requests per minute.
\nKnowledge Set Operations: POST, PUT, PATCH, and DELETE requests for are limited to 32 requests per minute.
Get conversation statistics for a project
\nTotalMessages
\nTotalConversations
\nAvgMessages
\n{\n\"TotalMessages\": 10,\n\"TotalConversations\": 5,\n\"AvgMessages\": 2\n}\n\ntimestamp
\n","type":"text/plain"},"key":"from","value":""},{"disabled":true,"description":{"content":"timestamp
\n","type":"text/plain"},"key":"to","value":""},{"disabled":true,"description":{"content":"Necessary if api key has no specific
\n","type":"text/plain"},"key":"projectId","value":""}],"variable":[]}},"response":[],"_postman_id":"1ddf506a-2269-42ee-947b-964968f296f6"}],"id":"ae702bcb-b9e5-4469-8dc7-cef00e504fc5","_postman_id":"ae702bcb-b9e5-4469-8dc7-cef00e504fc5","description":""},{"name":"Chat","item":[{"name":"Get welcomes message","id":"d6cc9517-bf40-4bb3-8bd0-4ff8ca49fc3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"your_api_key","type":"text"}],"url":"https://api.chathive.app/api/v1.0/chat/welcome_message?language=nl&stream=true","description":"Get the welcome message for a specific language.
If language is not provided the default language from the project will be used.
Stream: false
\n{\n \"message\": \"👋 Welcome to our website! Need assistance?. Don't hesitate to start the conversation. 😊\"\n}\n\nStream: true
\nStreams the welcome message in parts
\n\n\nStream responses can result in abnormal response in Postman.
\n
status code: 404
\n","urlObject":{"path":["api","v1.0","chat","welcome_message"],"host":["https://api.chathive.app"],"query":[{"key":"language","value":"nl"},{"key":"stream","value":"true"}],"variable":[]}},"response":[],"_postman_id":"d6cc9517-bf40-4bb3-8bd0-4ff8ca49fc3c"},{"name":"Get lead generation fields","id":"3b8fad3d-b982-40ca-a1b3-77e2d639c90b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"your_api_key","type":"text"}],"url":"https://api.chathive.app/api/v1.0/chat/lead_generation/fields?language=en","description":"Get the lead generation fields for the given language.
\nIf language is not set, the default language will be used.
\nEach fields contains the following configurations
\n{\n \"language\": \"en\",\n \"fields\": [{\n \"index\": 0,\n \"key\": \"email\",\n \"type\": \"email\" | \"text\" | \"number\" | \"textarea\",\n \"isRequired\": true,\n \"config\": {\n \"label\": \"Email\",\n \"placeholder\": \"johndoe@vlaio.be\",\n \"helpText\": \"Optional help text\",\n },\n }],\n}\n\nGet source references from a message
\n[\n {\n \"_id\": \"650046d782aa54000862e299\",\n \"url\": \"https://chathive.co/platform\",\n \"title\": \"platform - chathive\",\n \"rootUrl\": \"https://chathive.co\",\n \"type\": \"website\",\n \"createdAt\": \"2023-09-12T11:09:11.727Z\",\n \"updatedAt\": \"2023-09-12T11:09:12.650Z\",\n \"score\": 0.760878384,\n \"chunkId\": \"650046d782aa54000862e299_0\"\n }\n]\n\nSend message and get a GPT generated reply
\nmessage: Message prompt
\nlanguage: ISO 639-1 language codes (optional)
\nsessionId: Unique string generated by you to distindistinguish conversations. When sessionId change all previous conversation context will be lost and it will be like a new conversation has started
\nallowToolCall: enabled or disable tool calls (optional)
Default true
Api returns a stream event where the response is sent back incrementally in chunks.
\nData: partial string of the resposne
\nEnd: when all chunks are send
\nError: When something went wrong
\nThe response header contains the following values
\nmessageId: the id of the response message
\nsessionId: the session id to which the message belongs to.
\n\n\n","urlObject":{"path":["api","v1.0","chat","send_message"],"host":["https://api.chathive.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"0d56d68b-8561-4bc4-bcaf-059f107f445c"},{"name":"Send lead generation","event":[{"listen":"prerequest","script":{"id":"f342a895-28fd-46fd-ba18-225e586cf6e2","exec":["const interval = setTimeout(() => {}, Number.MAX_SAFE_INTEGER);","","let promiseNumber = 0;","","function resolvedPromise() {"," return new Promise((resolve, reject) => {"," pm.sendRequest(\"http://localhost:5050/external_todo_rename/v1/send_message\", (err, res) => {"," if (err) {"," console.log(err);"," reject();"," } else {"," console.log(`Resolved promise ${++promiseNumber}`);"," resolve();"," }"," });"," });","}","","resolvedPromise()"," .then(resolvedPromise)"," .then(resolvedPromise)"," .then(() => clearTimeout(interval))"," .catch(err => {"," console.log(err);"," clearTimeout(interval);"," });"],"type":"text/javascript","packages":{}}}],"id":"4b2deb63-79b4-444d-94b1-67638e7b7711","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"your_api_key"}],"body":{"mode":"raw","raw":"{\n \"language\": \"nl\",\n \"fields\": { \"email\": \"\", [key]: \"value\" }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chathive.app/api/v1.0/chat/session/:sessionId/lead_generation","description":"Stream responses are not supported in postman, postman test can result in abnormal response.
\n
Send lead generation field data and get a GPT generated reply.
\nApi returns a stream where each chunk is part of the response message
\n\n\n","urlObject":{"path":["api","v1.0","chat","session",":sessionId","lead_generation"],"host":["https://api.chathive.app"],"query":[],"variable":[{"type":"any","value":"","key":"sessionId"}]}},"response":[],"_postman_id":"4b2deb63-79b4-444d-94b1-67638e7b7711"},{"name":"Vote message","event":[{"listen":"prerequest","script":{"id":"f342a895-28fd-46fd-ba18-225e586cf6e2","exec":["const interval = setTimeout(() => {}, Number.MAX_SAFE_INTEGER);","","let promiseNumber = 0;","","function resolvedPromise() {"," return new Promise((resolve, reject) => {"," pm.sendRequest(\"http://localhost:5050/external_todo_rename/v1/send_message\", (err, res) => {"," if (err) {"," console.log(err);"," reject();"," } else {"," console.log(`Resolved promise ${++promiseNumber}`);"," resolve();"," }"," });"," });","}","","resolvedPromise()"," .then(resolvedPromise)"," .then(resolvedPromise)"," .then(() => clearTimeout(interval))"," .catch(err => {"," console.log(err);"," clearTimeout(interval);"," });"],"type":"text/javascript","packages":{}}}],"id":"d8ab70da-be0e-4bce-8295-aba386724db8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"your_api_key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"vote\": \"positive | negative\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chathive.app/api/v1.0/chat/session/:sessionId/message/:messageId/vote","description":"Stream responses are not supported in postman, postman test can result in abnormal response.
\n
Let the chat contact vote on a message
\nstatus code 201 on success
\n","urlObject":{"path":["api","v1.0","chat","session",":sessionId","message",":messageId","vote"],"host":["https://api.chathive.app"],"query":[],"variable":[{"type":"any","value":"postman_test","key":"sessionId"},{"type":"any","value":"","key":"messageId"}]}},"response":[],"_postman_id":"d8ab70da-be0e-4bce-8295-aba386724db8"},{"name":"Update conversation","event":[{"listen":"prerequest","script":{"id":"f342a895-28fd-46fd-ba18-225e586cf6e2","exec":["const interval = setTimeout(() => {}, Number.MAX_SAFE_INTEGER);","","let promiseNumber = 0;","","function resolvedPromise() {"," return new Promise((resolve, reject) => {"," pm.sendRequest(\"http://localhost:5050/external_todo_rename/v1/send_message\", (err, res) => {"," if (err) {"," console.log(err);"," reject();"," } else {"," console.log(`Resolved promise ${++promiseNumber}`);"," resolve();"," }"," });"," });","}","","resolvedPromise()"," .then(resolvedPromise)"," .then(resolvedPromise)"," .then(() => clearTimeout(interval))"," .catch(err => {"," console.log(err);"," clearTimeout(interval);"," });"],"type":"text/javascript","packages":{}}}],"id":"0eeb36f7-99a8-4990-bf5b-fee9e33e51aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"x-api-key","value":"your_api_key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"id\": \"string\",\n \"email\": \"string\",\n \"lastName\": \"string\",\n \"firstName\": \"string\",\n \"avatar\": \"string\"\n },\n \"context\": {\n \"key\": \"string | number | undefined | boolean\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chathive.app/api/v1.0/chat/session/:sessionId","description":"Update a conversation and provide extra information to the conversation.
\n\n\nThis is a experimental API and may be subjected to changes
\n
Customer: Information about the person who is sending a message (optional)
\nid: Unique id of the customer from you (optional)
\nemail (optional)
\nlastName (optional)
\nfirstName (optional)
\navatar (optional)
\nContext: extra context that will be given to the agent to provide beter responses (optional)
this is a object with key and string value
status code 204 on success
\n","urlObject":{"path":["api","v1.0","chat","session",":sessionId"],"host":["https://api.chathive.app"],"query":[],"variable":[{"type":"any","value":"postman_test","key":"sessionId"}]}},"response":[],"_postman_id":"0eeb36f7-99a8-4990-bf5b-fee9e33e51aa"}],"id":"8ac66b55-307a-4312-a95c-f8aebebfdc4d","_postman_id":"8ac66b55-307a-4312-a95c-f8aebebfdc4d","description":""},{"name":"Documents","item":[{"name":"Create text document","id":"268914c3-fea3-4833-9c20-104af08bf36a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"your_api_key"}],"body":{"mode":"raw","raw":"{\n \"type\": \"text\",\n \"title\": \"\",\n \"text\": \"\",\n \"projectId\": \"\",\n \"priority\": \"veryLow | low | default | high | veryHigh | topPriority\",\n \"language\": \"en\",\n \"documentDate\": \"2024-08-24\",\n \"meta\": {\n \"key\": \"string | number | undefined\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chathive.app/api/v1.0/document","description":"Update a text document
\nTitle: title of the document
\nText: content of the document
\nProjectId: project where this document must be added to, only necessary when API key has access multiple projects (optional)
\nType: text
\nPriority: default to default (optional)
\nLanguage: ISO 639-1 language codes (optional)
\nDocumentDate: Date of the content not the date of creation (optional)
\nMeta: Object with extra values that can be used to improve document detection
\nStatus: 201
\nStatus: 200
\nUpdate a text document
\nQuestion (optional)
\nAnswer: (optional)
if answer is not set, no new training tokens will be used
ProjectId: project where this document must be added to, only necessary when API key has access multiple projects (optional)
\nType: faq
\nPriority: default to default (optional)
\nLanguage: ISO 639-1 language codes (optional)
\nDocumentDate: Date of the content not the date of creation (optional)
\nMeta: Object with extra values that can be used to improve document detection
\nStatus: 201
\nUpdate a text document
\nTitle: title of the document (optional)
\nText: content of the document (optional)
if text is not set, no new training tokens will be used
Type: text
\nPriority: default to default (optional)
\nLanguage: ISO 639-1 language codes (optional)
\nDocumentDate: Date of the content not the date of creation (optional)
\nMeta: Object with extra values that can be used to improve document detection
\nStatus: 200
\nStatus: 200
\nDocumentId: previous document id
\nNewDocumentId: if document id has changed this will be the id of the new document
\nUpdate a text document
\nQuestion (optional)
\nAnswer: (optional)
if answer is not set, no new training tokens will be used
Type: faq
\nPriority: default to default (optional)
\nLanguage: ISO 639-1 language codes (optional)
\nDocumentDate: Date of the content not the date of creation (optional)
\nMeta: Object with extra values that can be used to improve document detection
\nStatus: 200
\nStatus: 200
\nDocumentId: previous document id
\nNewDocumentId: if document id has changed this will be the id of the new document
\nDelete document by id
\nstatus: 200
\n","urlObject":{"path":["api","v1.0","document",":documentId"],"host":["https://api.chathive.app"],"query":[],"variable":[{"type":"any","value":"","key":"documentId"}]}},"response":[],"_postman_id":"c2754603-46b9-4410-91aa-879eac6b60c7"}],"id":"1066c1df-8169-4533-b896-bbbd09ea3203","_postman_id":"1066c1df-8169-4533-b896-bbbd09ea3203","description":""},{"name":"Projects","item":[{"name":"Get list of projects","id":"013543f8-401d-42ba-a163-4e16aef3ff03","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"your_api_key","type":"text"}],"url":"https://api.chathive.app/api/v1.0/project?limit=20&offset=0","description":"Get list of all projects in the organization
\n{\n \"data\": [{\n \"_id\": 1,\n \"organizationId\": 2,\n \"name\": \"project name\",\n \"avatar\": \"icon.png\",\n \"agent\": {\n \"name\": \"agent name\",\n \"avatar\": \"agent_avatar.png\",\n },\n \"isPrivate\": false,\n \"folderId\": 1,\n \"businessScope\": \"external\",\n \"apiKey\": \"aiek893kaikd-32cd\",\n \"createdAt\": \"2024-10-07T09:40:00.000+00:00\",\n \"updatedAt\": \"2024-10-07T09:40:00.000+00:00\",\n }],\n \"meta\": {\n \"limit\": 20,\n \"offset\":0,\n \"total\":1,\n }\n}\n\nGet list of all projects in the organization
\n{\n \"data\": [{\n \"_id\": 1,\n \"organizationId\": 2,\n \"name\": \"project name\",\n \"avatar\": \"icon.png\",\n \"agent\": {\n \"name\": \"agent name\",\n \"avatar\": \"agent_avatar.png\",\n },\n \"isPrivate\": false,\n \"folderId\": 1,\n \"businessScope\": \"external\",\n \"apiKey\": \"aiek893kaikd-32cd\",\n \"createdAt\": \"2024-10-07T09:40:00.000+00:00\",\n \"updatedAt\": \"2024-10-07T09:40:00.000+00:00\",\n }],\n \"meta\": {\n \"limit\": 20,\n \"offset\":0,\n \"total\":1,\n }\n}\n\nGet list of all sessions in the project
\n{\n \"data\": [{\n \"projectId\": \"3lkcsd3yyb6gx0r8jy9ugsap\",\n \"sessionId\": \"8syyfp6r6vg4et9h4czebvud\",\n \"organizationId\": \"gq0950c4yikccepvzzar9x6f\",\n \"customer\": {\n \"id\": \"ym6civsf9i2cphcoma5x9j8a\",\n \"email\": \"customer@email.co\",\n \"lastName\": \"doe\",\n \"firstName\": \"john\",\n \"avatar\": \"avatar.png\",\n },\n \"status\": \"completed\",\n \"seenBy\": false,\n \"createdAt\": \"2024-10-07T09:40:00.000+00:00\",\n \"updatedAt\": \"2024-10-07T09:40:00.000+00:00\",\n \"completedAt\": undefined,\n \"stoppedAt\": undefined,\n \"archivedAt\": undefined,\n}],\n \"meta\": {\n \"limit\": 20,\n \"offset\":0,\n \"total\":1,\n \"cursor\": \"next-cursor\",\n }\n}\n\nForm which position start to return session.
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"Total number of sessions to return.
\n","type":"text/plain"},"key":"limit","value":"20"},{"disabled":true,"description":{"content":"Provided cursor from your previous request to return the next batch of sessions.
\n","type":"text/plain"},"key":"cursor","value":""},{"disabled":true,"description":{"content":"true | false
\n","type":"text/plain"},"key":"archivedOnly","value":""},{"disabled":true,"description":{"content":"\"created\" | \"inProgress\" | \"stopped\" | \"started\" | \"completed\"
\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"timestamp
\n","type":"text/plain"},"key":"from","value":""},{"disabled":true,"description":{"content":"timestamp
\n","type":"text/plain"},"key":"to","value":""},{"disabled":true,"description":{"content":"\"seen\" | \"unseen\" | \"all\"
\n","type":"text/plain"},"key":"seen","value":""},{"disabled":true,"description":{"content":"Necessary if api key has no specific
\n","type":"text/plain"},"key":"projectId","value":""}],"variable":[]}},"response":[],"_postman_id":"a9b70a03-bedf-4570-8f31-f71d9a5f2e7b"},{"name":"Get session detail","id":"da5b5bc9-04c2-424b-9cce-1c03b9872f02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"your_api_key","type":"text"}],"url":"https://api.chathive.app/api/v1.0/session/:sessionId","description":"Get session detail
\n{\n \"data\": {\n \"projectId\": \"3lkcsd3yyb6gx0r8jy9ugsap\",\n \"sessionId\": \"8syyfp6r6vg4et9h4czebvud\",\n \"organizationId\": \"gq0950c4yikccepvzzar9x6f\",\n \"customer\": {\n \"id\": \"ym6civsf9i2cphcoma5x9j8a\",\n \"email\": \"customer@email.co\",\n \"lastName\": \"doe\",\n \"firstName\": \"john\",\n \"avatar\": \"avatar.png\",\n },\n \"status\": \"completed\",\n \"seenBy\": false,\n \"createdAt\": \"2024-10-07T09:40:00.000+00:00\",\n \"updatedAt\": \"2024-10-07T09:40:00.000+00:00\",\n \"completedAt\": undefined,\n \"stoppedAt\": undefined,\n \"archivedAt\": undefined,\n }\n}\n\nAdd 1 or more tags to a session.
\nIf any of the provided tags are not part of the API’s organization, none of the tags will be added.
\nStatus: 204
\n","urlObject":{"path":["api","v1.0","session",":sessionId","tags"],"host":["https://api.chathive.app"],"query":[],"variable":[{"type":"any","value":"","key":"sessionId"}]}},"response":[],"_postman_id":"8fb1fa5b-7eae-4a27-bf9c-4abf8e2be8e1"},{"name":"Archive session","id":"c1c87fd2-54f6-4e4f-b30a-5e41124d0e5f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-api-key","value":"your_api_key","type":"text"}],"body":{"mode":"raw","raw":"{ \"archive\": true }","options":{"raw":{"language":"json"}}},"url":"https://api.chathive.app/api/v1.0/session/:sessionId/archive","description":"Archive / unarchive session
\nStatus: 200
\n","urlObject":{"path":["api","v1.0","session",":sessionId","archive"],"host":["https://api.chathive.app"],"query":[{"disabled":true,"key":"projectId","value":""}],"variable":[{"type":"any","value":"","key":"sessionId"}]}},"response":[],"_postman_id":"c1c87fd2-54f6-4e4f-b30a-5e41124d0e5f"},{"name":"Update session","id":"ee63c5ed-bf7f-4d46-af2b-1738e91f7f17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-api-key","value":"1929099fb102fj0k8lMiYb523mKZpIXeVA9heL01WIicF4b1IBO6MerfXZMohp1PPeRSa2zKDMq7iybn8i0GOkHwZQT-bg1A7WS1vlxYzJKhWU7NTzB8LCaS0EhEwbtxFKiBSbZKLqtRcQPrL7IIr8RfjYEMkcturmuIQoBJ1jnNvfFaiMn2biBtx6JNzJVEQiU274F9U1t0wmAXGB8XLmEsYY4jxVsRRf2UL45d8UzYrkUc856wEgtNUaKt0QBnZrJ4fktdjhK","type":"text"}],"body":{"mode":"raw","raw":"{\n \"meta\": {\n \"letsgo\": true,\n \"nice\": false\n },\n \"customerData\": {\n \"id\": \"d\",\n \"email\": \"qf\",\n \"lastName\": \"\",\n \"firstName\": \"sfd\",\n \"avatar\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chathive.app/api/v1.0/session/1924cb98172EnMfyp2Bmiewkw_ZOC2t4-rw","description":"Session has limited fields that can be updated.
\nStatus: 200
\n","urlObject":{"path":["api","v1.0","session","1924cb98172EnMfyp2Bmiewkw_ZOC2t4-rw"],"host":["https://api.chathive.app"],"query":[{"disabled":true,"key":"projectId","value":""}],"variable":[]}},"response":[],"_postman_id":"ee63c5ed-bf7f-4d46-af2b-1738e91f7f17"},{"name":"Delete tags","id":"4e205c94-2eeb-4614-bb80-b4faae6bfe66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","value":"your_api_key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"tagIds\": [ \"67f78648d61dbb1b5e00fad4\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chathive.app/api/v1.0/session/:sessionId/tags","description":"Remove one or more tags from a session
If any of the provided tags are not part of the API’s organization, none of the tags will be removed.
Status: 204
\n","urlObject":{"path":["api","v1.0","session",":sessionId","tags"],"host":["https://api.chathive.app"],"query":[],"variable":[{"type":"any","value":"","key":"sessionId"}]}},"response":[],"_postman_id":"4e205c94-2eeb-4614-bb80-b4faae6bfe66"}],"id":"24f86077-7849-4687-88b4-47a460bc6964","_postman_id":"24f86077-7849-4687-88b4-47a460bc6964","description":""},{"name":"Tags","item":[{"name":"Get list of tags","id":"a2b79ec5-5116-46be-b15e-a8a66a6d7c54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"your_api_key","type":"text"}],"url":"https://api.chathive.app/api/v1.0/tag?offset=0&limit=20","description":"Get list of all tags in the organization
\n{\n \"data\": [\n {\n \"_id\": \"Pq0950c4yikcca32zzargxp9\",\n \"color\": \"#000000\",\n \"name\": \"tagName\",\n \"description\": \"tagDescription\",\n \"organizationId\": \"gq0950c4yikccepvzzar9x6f\",\n \"createdBy\": {\n \"_id\": \"3\",\n \"lastName\": \"creatorLastName\",\n \"firstName\": \"creatorFirstName\"\n },\n \"createdAt\": \"2025-03-20T14:50:33.159Z\",\n \"updatedAt\": \"2025-03-20T14:50:33.159Z\",\n \"__v\": 0,\n \"conversationCount\": 0\n }\n ],\n \"total\": 3,\n \"tagCountAllTags\": 3\n}\n\nTotal number of tags to return. Must be smaller than 1 000.
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"Form which position start to return projects.
\n","type":"text/plain"},"key":"limit","value":"20"},{"disabled":true,"description":{"content":"Search on tag name.
\n","type":"text/plain"},"key":"q","value":""},{"disabled":true,"description":{"content":"true | false\nWhen true, conversation count is not included.
\n","type":"text/plain"},"key":"compact","value":"true"}],"variable":[]}},"response":[],"_postman_id":"a2b79ec5-5116-46be-b15e-a8a66a6d7c54"},{"name":"Create tag","id":"b00f35e5-700d-4843-8358-beb37aa08734","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"your_api_key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Tag name\",\n \"description\": \"When to use the tag\",\n \"color\": \"#F8C945\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chathive.app/api/v1.0/tag","description":"Create a new tag in the organization
\n{\n \"_id\": \"Pq0950c4yikcca32zzargxp9\",\n \"color\": \"#F8C945\",\n \"name\": \"tagName\",\n \"description\": \"tagDescription\",\n \"organizationId\": \"gq0950c4yikccepvzzar9x6f\",\n \"createdBy\": \"loP910c4yi1c4ar1poa3g5ae\",\n \"createdAt\": \"2025-03-25T10:59:02.927Z\",\n \"updatedAt\": \"2025-03-25T10:59:02.927Z\",\n \"__v\": 0\n}\n\nUpdate a tag by id
\n{\n \"_id\": \"Pq0950c4yikcca32zzargxp9\",\n \"name\": \"tagName\",\n \"description\": \"\",\n \"color\": \"#F8C945\",\n \"organizationId\": \"gq0950c4yikccepvzzar9x6f\",\n \"createdAt\": \"2025-03-26T10:23:33.507Z\",\n \"updatedAt\": \"2025-03-26T11:51:46.396Z\",\n \"__v\": 0\n}\n\nDelete a tag by id
\nStatus: 204
\n","urlObject":{"path":["api","v1.0","tag",":tagId"],"host":["https://api.chathive.app"],"query":[],"variable":[{"type":"any","value":"","key":"tagId"}]}},"response":[],"_postman_id":"43547146-9882-485e-946c-e60f0d9374fa"}],"id":"f06aef04-54e1-41f5-aef6-af6d8b1aa9da","_postman_id":"f06aef04-54e1-41f5-aef6-af6d8b1aa9da","description":""},{"name":"Trigger","item":[{"name":"Execute trigger","id":"f93073cf-19c0-4742-ab4b-749964f53b4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"your_api_key","type":"text"}],"body":{"mode":"raw","raw":"{\n \"instruction\": \"string | object\",\n \"sessionId\": \"string\",\n \"environment\": \"string\",\n \"language\": \"en\",\n \"timezone\": \"Europe/Brussels\",\n \"customer\": {\n \"id\": \"string\",\n \"email\": \"string\",\n \"lastName\": \"string\",\n \"firstName\": \"string\",\n \"avatar\": \"string\"\n },\n \"context\": {\n \"key\": \"string | number | undefined | boolean\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.chathive.app/api/v1.0/project/:projectId/trigger/:key","description":"Instruction: Extra instruction that will be provided to the agent, can be a string or object (optional)
\nlanguage: ISO 639-1 language codes (optional)
\nsessionId: Unique string generated by you to distindistinguish conversations. When sessionId change all previous conversation context will be lost and it will be like a new conversation has started (optional)
\nEnvironment: String that can be used to identify in the analytics from where the request came. Default: \"api\" (optional)
\nTimezone: Override the default timezone of your project. (optional)
\nCustomer: Customer information that should be used and linked to the conversation.(optional)
\nid: Unique id of the customer from you (optional)
\nemail (optional)
\nlastName (optional)
\nfirstName (optional)
\navatar (optional)
\nContext: Extra context that will be given to the agent to provide beter responses (optional)
this is a object with key and string value
Verify if the API key is valid
\nstatus code: 200
\n","urlObject":{"path":["api","v1.0","verify"],"host":["https://api.chathive.app"],"query":[],"variable":[]}},"response":[],"_postman_id":"9b502257-c703-48a6-9f8b-12eba77ab169"},{"name":"New Request","id":"9b736c03-c804-4fe7-ba2e-953fdf993991","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"9b736c03-c804-4fe7-ba2e-953fdf993991"}],"event":[{"listen":"prerequest","script":{"id":"5ded0802-6293-4a89-b580-57d6a31d155d","type":"text/javascript","requests":{},"exec":[""]}},{"listen":"test","script":{"id":"fbaddfc3-6834-43fb-8b1b-300779feef17","type":"text/javascript","requests":{},"exec":[""]}}],"variable":[{"key":"api-key","value":"your_api_key"},{"key":"base_url","value":"https://api.chathive.app"}]}