{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/api-reference/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["api-container","api-content","endpoint","api-examples","tabs","tab","code-group"]},"redocly_category":"API Reference","searchWeight":120,"type":"markdown"},"seo":{"title":"Retrieve a chat artifact ref","description":"Complete API reference and documentation for Freddy AI-powered backend system by Aitronos","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"retrieve-a-chat-artifact-ref","__idx":0},"children":["Retrieve a chat artifact ref"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns a single chat artifact ref plus a freshly-fetched title from the underlying artifact entity. Clients use this endpoint to detect stale ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["title_snapshot"]}," values (display the fresh title in the chip) and to detect entities that have been deleted in their workspace (render the deleted-artifact chip placeholder). The fresh-title lookup is best-effort — on any backend error or missing entity, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fresh_title"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entity_exists"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]},{"$$mdtype":"Tag","name":"ApiContainer","attributes":{},"children":[{"$$mdtype":"Tag","name":"ApiContent","attributes":{},"children":[{"$$mdtype":"Tag","name":"Endpoint","attributes":{"method":"GET","path":"https://api.aitronos.com/v1/chat-artifacts/refs/{ref_id}"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"path-parameters","__idx":1},"children":["Path parameters"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ref_id"]}]}," string ",{"$$mdtype":"Tag","name":"em","attributes":{"style":{"color":"#ef4444 !important","fontWeight":"600 !important","fontStyle":"normal !important"}},"children":["required"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Identifier of the chat artifact ref to retrieve. Always prefixed ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["carfref_"]}," — returned by the list endpoint or by the agent-tool wrapper at artifact creation."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"returns","__idx":2},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ChatArtifactRefDetailResponse"]}," object — the persisted ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ref"]}," row, the canonical ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fresh_title"]}," freshly fetched from the underlying artifact entity (or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]}," if the entity is gone), and an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entity_exists"]}," boolean flag."]}]},{"$$mdtype":"Tag","name":"ApiExamples","attributes":{},"children":[{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Request","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeGroup","attributes":{"mode":"dropdown"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","data-title":"cURL","header":{"title":"cURL","controls":{"copy":{}}},"source":"curl -X GET \"https://api.aitronos.com/v1/chat-artifacts/refs/carfref_aaaa1111bbbb2222cccc3333dddd4444\" \\\n  -H \"X-API-Key: $FREDDY_API_KEY\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"python","data-title":"Python SDK","header":{"title":"Python SDK","controls":{"copy":{}}},"source":"from aitronos import Aitronos\n\nclient = Aitronos(api_key=\"your-api-key\")\ndetail = client.chat_artifacts.refs.retrieve(\n    ref_id=\"carfref_aaaa1111bbbb2222cccc3333dddd4444\",\n)\nprint(detail.ref.title_snapshot, detail.fresh_title, detail.entity_exists)\n","lang":"python"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"python","data-title":"Python","header":{"title":"Python","controls":{"copy":{}}},"source":"import os, requests\n\nresponse = requests.get(\n    \"https://api.aitronos.com/v1/chat-artifacts/refs/carfref_aaaa1111bbbb2222cccc3333dddd4444\",\n    headers={\"X-API-Key\": os.environ[\"FREDDY_API_KEY\"]},\n)\nprint(response.json())\n","lang":"python"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","data-title":"JavaScript","header":{"title":"JavaScript","controls":{"copy":{}}},"source":"const response = await fetch(\n  \"https://api.aitronos.com/v1/chat-artifacts/refs/carfref_aaaa1111bbbb2222cccc3333dddd4444\",\n  { headers: { \"X-API-Key\": process.env.FREDDY_API_KEY } },\n);\nconsole.log(await response.json());\n","lang":"javascript"},"children":[]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Response","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"ref\": {\n    \"id\": \"carfref_aaaa1111bbbb2222cccc3333dddd4444\",\n    \"organization_id\": \"org_abc\",\n    \"created_by_user_id\": \"usr_abc\",\n    \"smoc_entity_type\": \"document\",\n    \"smoc_entity_id\": \"itm_revenue_plan\",\n    \"created_in_thread_id\": \"thread_qwerty\",\n    \"created_in_message_id\": \"msg_abcd1234\",\n    \"title_snapshot\": \"Q1 Revenue Plan\",\n    \"title_snapshot_at\": \"2026-04-19T14:00:00Z\",\n    \"last_opened_at\": \"2026-04-19T15:22:11Z\",\n    \"created_at\": \"2026-04-19T14:00:00Z\",\n    \"deleted_at\": null\n  },\n  \"fresh_title\": \"Q1 Revenue Plan (updated)\",\n  \"entity_exists\": true\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Error","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"RESOURCE_NOT_FOUND\",\n    \"message\": \"The requested resource could not be found.\",\n    \"system_message\": \"Chat artifact ref not found\",\n    \"type\": \"client_error\",\n    \"status\": 404,\n    \"details\": {\"ref_id\": \"carfref_aaaa1111bbbb2222cccc3333dddd4444\"},\n    \"trace_id\": \"...\",\n    \"timestamp\": \"...\"\n  }\n}\n","lang":"json"},"children":[]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related-resources","__idx":3},"children":["Related Resources"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api-reference/chat-artifacts/list-refs"},"children":["List chat artifact refs"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/api-reference/chat-artifacts/delete-ref"},"children":["Delete a chat artifact ref"]}]}]}]},"headings":[{"value":"Retrieve a chat artifact ref","id":"retrieve-a-chat-artifact-ref","depth":1},{"value":"Path parameters","id":"path-parameters","depth":2},{"value":"Returns","id":"returns","depth":2},{"value":"Related Resources","id":"related-resources","depth":2}],"frontmatter":{"title":"Retrieve a chat artifact ref","seo":{"title":"Retrieve a chat artifact ref"}},"lastModified":"2026-10-26T18:32:31.521Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/api-reference/chat-artifacts/get-ref","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}