{"items":[{"type":"link","label":"HRC Ledger API","link":"/docs/openapi","routeSlug":"/docs/openapi","content":{"contentType":"overview","meta":{"name":"HRC Ledger API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/docs/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/docs/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://hrcledger.com/contact","url":"https://hrcledger.com/contact"},{"kind":"email","title":"HRC Ledger","email":"contact@societyhealth.co","label":"contact@societyhealth.co","withCopyButton":true,"copyContent":"contact@societyhealth.co"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"HRC Ledger terms","url":"https://hrcledger.com/terms"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"python","title":"Python","lang":"Python"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"HRC Ledger API (v1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The HRC Ledger API gives a healthcare investment banker's own code what HRC Ledger holds: healthcare organizations and public contracts, your saved Lists, action plans, drafts and conversations, and the HRC Ledger assistant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authenticate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with an API key in one header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hck_live_..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A key works on any plan; each key carries the scopes it was made with."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One envelope"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on every route: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ ok: true, data, page?, total? }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ ok: false, error: { code, message, ...details } }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Every response carries an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Request-Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header; quote it when you ask us about a call."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning is in the path"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api/v1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"): a change that removes or retypes a field in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ships at a new path; adding a field does not."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Guides"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — getting started, keys and scopes, errors, pagination and versioning, and the changelog — are at https://docs.hrcledger.com/developer/."},"children":[]}]}]}]}],"sectionId":"/docs/openapi"},{"nodeType":"external-docs","url":"https://docs.hrcledger.com/developer/","description":"Getting started"}],"sectionId":"/docs/openapi"}]}]}},{"type":"separator","label":"Read","content":null},{"type":"group","label":"contracts","link":"/docs/openapi/contracts","routeSlug":"/docs/openapi/contracts","items":[{"label":"Search contracts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/contracts/listcontracts","routeSlug":"/docs/openapi/contracts/listcontracts","metadata":{"seo":{"title":"Search contracts","description":"Use this to find contracts and solicitations by keyword, place, buyer, code, value or due date. Returns one page of contracts with the true total across every page. Uncapped for every key; your plan only sets how far back the archive reaches."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listContracts","name":"Search contracts","isWebhook":false,"pointer":"/paths/~1api~1v1~1contracts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search contracts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this to find contracts and solicitations by keyword, place, buyer, code, value or due date. Returns one page of contracts with the true "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" across every page. Uncapped for every key; your plan only sets how far back the archive reaches."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hck_live_..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Scopes are per key: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contracts:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"market:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent:ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"q","in":"query","schemaId":"schema_0"},{"name":"jurisdiction","in":"query","schemaId":"schema_1"},{"name":"buyerType","in":"query","schemaId":"schema_1"},{"name":"setAside","in":"query","schemaId":"schema_1"},{"name":"opportunityKind","in":"query","schemaId":"schema_1"},{"name":"personas","in":"query","schemaId":"schema_1"},{"name":"buyerClass","in":"query","schemaId":"schema_1"},{"name":"naics","in":"query","schemaId":"schema_1"},{"name":"psc","in":"query","schemaId":"schema_1"},{"name":"category","in":"query","schemaId":"schema_0"},{"name":"tag","in":"query","schemaId":"schema_1"},{"name":"type","in":"query","schemaId":"schema_0"},{"name":"recordType","in":"query","schemaId":"schema_1"},{"name":"status","in":"query","schemaId":"schema_2"},{"name":"minValue","in":"query","schemaId":"schema_3"},{"name":"maxValue","in":"query","schemaId":"schema_3"},{"name":"dueBefore","in":"query","schemaId":"schema_4"},{"name":"dueAfter","in":"query","schemaId":"schema_4"},{"name":"postedAfter","in":"query","schemaId":"schema_4"},{"name":"firstSeenAfter","in":"query","schemaId":"schema_4"},{"name":"window","in":"query","schemaId":"schema_0"},{"name":"commercialCategory","in":"query","schemaId":"schema_0"},{"name":"includePastDue","in":"query","schemaId":"schema_5"},{"name":"includeArchived","in":"query","schemaId":"schema_5"},{"name":"sort","in":"query","schemaId":"schema_6"},{"name":"page","in":"query","schemaId":"schema_7"},{"name":"limit","in":"query","schemaId":"schema_7"}],"pointer":"/paths/~1api~1v1~1contracts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/contracts","servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"parameters":{"path":[],"query":[{"name":"q","in":"query","schemaId":"schema_0"},{"name":"jurisdiction","in":"query","schemaId":"schema_1"},{"name":"buyerType","in":"query","schemaId":"schema_1"},{"name":"setAside","in":"query","schemaId":"schema_1"},{"name":"opportunityKind","in":"query","schemaId":"schema_1"},{"name":"personas","in":"query","schemaId":"schema_1"},{"name":"buyerClass","in":"query","schemaId":"schema_1"},{"name":"naics","in":"query","schemaId":"schema_1"},{"name":"psc","in":"query","schemaId":"schema_1"},{"name":"category","in":"query","schemaId":"schema_0"},{"name":"tag","in":"query","schemaId":"schema_1"},{"name":"type","in":"query","schemaId":"schema_0"},{"name":"recordType","in":"query","schemaId":"schema_1"},{"name":"status","in":"query","schemaId":"schema_2"},{"name":"minValue","in":"query","schemaId":"schema_3"},{"name":"maxValue","in":"query","schemaId":"schema_3"},{"name":"dueBefore","in":"query","schemaId":"schema_4"},{"name":"dueAfter","in":"query","schemaId":"schema_4"},{"name":"postedAfter","in":"query","schemaId":"schema_4"},{"name":"firstSeenAfter","in":"query","schemaId":"schema_4"},{"name":"window","in":"query","schemaId":"schema_0"},{"name":"commercialCategory","in":"query","schemaId":"schema_0"},{"name":"includePastDue","in":"query","schemaId":"schema_5"},{"name":"includeArchived","in":"query","schemaId":"schema_5"},{"name":"sort","in":"query","schemaId":"schema_6"},{"name":"page","in":"query","schemaId":"schema_7"},{"name":"limit","in":"query","schemaId":"schema_7"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","422","429","503"],"pointer":"/api/v1/contracts","href":"contracts/listcontracts","openApiOperationId":"listContracts","summary":"Search contracts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The requested page, with the true total across all pages.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_8","exampleIds":["paths/~1api~1v1~1contracts/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_8","exampleIds":["paths/~1api~1v1~1contracts/get/responses/200/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_or_malformed_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, or one that is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a valid key sent any other way lands here. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a well-formed key we do not hold, or a revoked one. The message names which."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key lacks the scope this route requires; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insufficient_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The query string did not parse; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the issues. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_query"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A ceiling was reached: the per-minute request limit ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the per-key day ceiling of 200 runs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.resets_in_seconds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or the product's own daily model budget ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget_exhausted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fails closed, nothing spent: no database ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"database_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or no usable model provider ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"}],"pointer":"/paths/~1api~1v1~1contracts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_8","exampleIds":["paths/~1api~1v1~1contracts/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_8","exampleIds":["paths/~1api~1v1~1contracts/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"403","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"422","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"429","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"503","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contracts/listcontracts"}],"panels":[]}]},"httpPath":"/api/v1/contracts"},{"label":"Read one contract","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/contracts/getcontract","routeSlug":"/docs/openapi/contracts/getcontract","metadata":{"seo":{"title":"Read one contract","description":"Use this when you already have a contract's slug (from a search or a citation). Returns that one contract, or 404 not_found when no contract has the slug."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getContract","name":"Read one contract","isWebhook":false,"pointer":"/paths/~1api~1v1~1contracts~1{slug}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Read one contract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this when you already have a contract's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"slug"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (from a search or a citation). Returns that one contract, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404 not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when no contract has the slug."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hck_live_..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Scopes are per key: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contracts:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"market:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent:ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"slug","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1contracts~1{slug}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/contracts/{slug}","servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"parameters":{"path":[{"name":"slug","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404","429","503"],"pointer":"/api/v1/contracts/{slug}","href":"contracts/getcontract","openApiOperationId":"getContract","summary":"Read one contract"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contract.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_9","exampleIds":["paths/~1api~1v1~1contracts~1{slug}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_9","exampleIds":["paths/~1api~1v1~1contracts~1{slug}/get/responses/200/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_or_malformed_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, or one that is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a valid key sent any other way lands here. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a well-formed key we do not hold, or a revoked one. The message names which."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key lacks the scope this route requires; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insufficient_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No such record. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A ceiling was reached: the per-minute request limit ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the per-key day ceiling of 200 runs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.resets_in_seconds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or the product's own daily model budget ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget_exhausted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fails closed, nothing spent: no database ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"database_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or no usable model provider ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"}],"pointer":"/paths/~1api~1v1~1contracts~1{slug}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_9","exampleIds":["paths/~1api~1v1~1contracts~1{slug}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_9","exampleIds":["paths/~1api~1v1~1contracts~1{slug}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"403","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"404","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"429","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"503","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contracts/getcontract"}],"panels":[]}]},"httpPath":"/api/v1/contracts/{slug}"}],"content":{"contentType":"group","meta":{"name":"contracts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"contracts","showPageActions":true},{"nodeType":"markdoc","content":"Public healthcare contracts and solicitations: search them and read one."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/contracts","summary":"Search contracts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contracts/listcontracts","deprecated":false},{"title":"/api/v1/contracts/{slug}","summary":"Read one contract","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contracts/getcontract","deprecated":false}]}]}]}]}},{"type":"group","label":"organizations","link":"/docs/openapi/organizations","routeSlug":"/docs/openapi/organizations","items":[{"label":"Search organizations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/organizations/listorgs","routeSlug":"/docs/openapi/organizations/listorgs","metadata":{"seo":{"title":"Search organizations","description":"Use this to find hospitals, health systems and other providers by segment, state, metro, size or name. Returns one page of organizations, each with its CCN, NPI and EIN where we hold them, and the true total. Uncapped for every key."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOrgs","name":"Search organizations","isWebhook":false,"pointer":"/paths/~1api~1v1~1market~1orgs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search organizations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this to find hospitals, health systems and other providers by segment, state, metro, size or name. Returns one page of organizations, each with its CCN, NPI and EIN where we hold them, and the true "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Uncapped for every key."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hck_live_..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Scopes are per key: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contracts:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"market:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent:ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"segment","in":"query","schemaId":"schema_1"},{"name":"state","in":"query","schemaId":"schema_1"},{"name":"cbsa","in":"query","schemaId":"schema_1"},{"name":"has_aco_participation","in":"query","schemaId":"schema_5"},{"name":"minBeds","in":"query","schemaId":"schema_3"},{"name":"maxBeds","in":"query","schemaId":"schema_3"},{"name":"q","in":"query","schemaId":"schema_0"},{"name":"sort","in":"query","schemaId":"schema_10"},{"name":"page","in":"query","schemaId":"schema_7"},{"name":"limit","in":"query","schemaId":"schema_7"}],"pointer":"/paths/~1api~1v1~1market~1orgs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/market/orgs","servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"parameters":{"path":[],"query":[{"name":"segment","in":"query","schemaId":"schema_1"},{"name":"state","in":"query","schemaId":"schema_1"},{"name":"cbsa","in":"query","schemaId":"schema_1"},{"name":"has_aco_participation","in":"query","schemaId":"schema_5"},{"name":"minBeds","in":"query","schemaId":"schema_3"},{"name":"maxBeds","in":"query","schemaId":"schema_3"},{"name":"q","in":"query","schemaId":"schema_0"},{"name":"sort","in":"query","schemaId":"schema_10"},{"name":"page","in":"query","schemaId":"schema_7"},{"name":"limit","in":"query","schemaId":"schema_7"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","429","503"],"pointer":"/api/v1/market/orgs","href":"organizations/listorgs","openApiOperationId":"listOrgs","summary":"Search organizations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The requested page, with the true total across all pages.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_11","exampleIds":["paths/~1api~1v1~1market~1orgs/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_11","exampleIds":["paths/~1api~1v1~1market~1orgs/get/responses/200/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_or_malformed_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, or one that is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a valid key sent any other way lands here. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a well-formed key we do not hold, or a revoked one. The message names which."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key lacks the scope this route requires; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insufficient_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A ceiling was reached: the per-minute request limit ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the per-key day ceiling of 200 runs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.resets_in_seconds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or the product's own daily model budget ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget_exhausted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fails closed, nothing spent: no database ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"database_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or no usable model provider ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"}],"pointer":"/paths/~1api~1v1~1market~1orgs/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_11","exampleIds":["paths/~1api~1v1~1market~1orgs/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_11","exampleIds":["paths/~1api~1v1~1market~1orgs/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"403","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"429","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"503","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/listorgs"}],"panels":[]}]},"httpPath":"/api/v1/market/orgs"}],"content":{"contentType":"group","meta":{"name":"organizations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"organizations","showPageActions":true},{"nodeType":"markdoc","content":"Hospitals, health systems and other provider organizations: search the market."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/market/orgs","summary":"Search organizations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organizations/listorgs","deprecated":false}]}]}]}]}},{"type":"separator","label":"Artifacts","content":null},{"type":"group","label":"lists","link":"/docs/openapi/lists","routeSlug":"/docs/openapi/lists","items":[{"label":"List your Lists","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/lists/listlists","routeSlug":"/docs/openapi/lists/listlists","metadata":{"seo":{"title":"List your Lists","description":"Your saved Lists of organizations, newest change first, without their rows. Use this when you need a List's id, or want to see which Lists exist before reading one. Newest change first, 25 to a page by default. Following is not listed here. total is null: this read does not count."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listLists","name":"List your Lists","isWebhook":false,"pointer":"/paths/~1api~1v1~1lists/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List your Lists","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your saved Lists of organizations, newest change first, without their rows. Use this when you need a List's id, or want to see which Lists exist before reading one. Newest change first, 25 to a page by default. Following is not listed here. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is null: this read does not count."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hck_live_..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Scopes are per key: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contracts:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"market:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent:ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_12"},{"name":"limit","in":"query","schemaId":"schema_13"},{"name":"purpose","in":"query","schemaId":"schema_14"},{"name":"archived","in":"query","schemaId":"schema_5"}],"pointer":"/paths/~1api~1v1~1lists/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/lists","servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_12"},{"name":"limit","in":"query","required":false,"schemaId":"schema_13"},{"name":"purpose","in":"query","required":false,"schemaId":"schema_14"},{"name":"archived","in":"query","required":false,"schemaId":"schema_5"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404","422","429","503"],"pointer":"/api/v1/lists","href":"lists/listlists","openApiOperationId":"listLists","summary":"List your Lists"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Done.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_15","exampleIds":["paths/~1api~1v1~1lists/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_15","exampleIds":["paths/~1api~1v1~1lists/get/responses/200/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_or_malformed_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, or one that is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a valid key sent any other way lands here. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a well-formed key we do not hold, or a revoked one. The message names which."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key lacks the scope this route requires; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insufficient_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No such record. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The query string did not parse; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the issues. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_query"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A ceiling was reached: the per-minute request limit ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the per-key day ceiling of 200 runs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.resets_in_seconds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or the product's own daily model budget ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget_exhausted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fails closed, nothing spent: no database ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"database_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or no usable model provider ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"}],"pointer":"/paths/~1api~1v1~1lists/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_15","exampleIds":["paths/~1api~1v1~1lists/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_15","exampleIds":["paths/~1api~1v1~1lists/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"403","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"404","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"422","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"429","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"503","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/lists/listlists"}],"panels":[]}]},"httpPath":"/api/v1/lists"},{"label":"Make a List","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/lists/createlist","routeSlug":"/docs/openapi/lists/createlist","metadata":{"seo":{"title":"Make a List","description":"Make a new List, optionally with organizations on it. Send an Idempotency-Key so a retry makes one List, not two. Use this when someone asks to save a set of organizations. Answers 201 with the List. The same Idempotency-Key and body again answers 200 with the same id; another body under that key is 409 idempotency_conflict. Rows added here read \"by API key\" in the app."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createList","name":"Make a List","isWebhook":false,"pointer":"/paths/~1api~1v1~1lists/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Make a List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Make a new List, optionally with organizations on it. Send an Idempotency-Key so a retry makes one List, not two. Use this when someone asks to save a set of organizations. Answers "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the List. The same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Idempotency-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and body again answers "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the same id; another body under that key is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409 idempotency_conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Rows added here read \"by API key\" in the app."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hck_live_..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Scopes are per key: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contracts:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"market:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent:ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_16","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 to 128 characters. A retry with the same key and body returns the first result; the same key with another body is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1v1~1lists/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_17","exampleIds":["paths/~1api~1v1~1lists/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_17","exampleIds":["paths/~1api~1v1~1lists/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1lists/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/lists","servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_16"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_17","exampleIds":["paths/~1api~1v1~1lists/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","201","401","403","404","409","422","429","503"],"pointer":"/api/v1/lists","href":"lists/createlist","openApiOperationId":"createList","summary":"Make a List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"schemaId":"schema_17","exampleIds":["paths/~1api~1v1~1lists/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_17","exampleIds":["paths/~1api~1v1~1lists/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A retry: the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Idempotency-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and body as a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before it; the same id."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_18","exampleIds":["paths/~1api~1v1~1lists/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_18","exampleIds":["paths/~1api~1v1~1lists/post/responses/200/content/application~1json/example"]},{"code":"201","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Made; a retry with the same key and body answers "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the same id."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_18","exampleIds":["paths/~1api~1v1~1lists/post/responses/201/content/application~1json/example"]}},"schemaId":"schema_18","exampleIds":["paths/~1api~1v1~1lists/post/responses/201/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_or_malformed_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, or one that is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a valid key sent any other way lands here. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a well-formed key we do not hold, or a revoked one. The message names which."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insufficient_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the key lacks this route's scope; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"owner_only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — only the owner can archive. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — restore it in the app before changing it."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No such record. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idempotency_conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Idempotency-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was used for a different request; send a new key. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revision_conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — someone saved a newer version; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.current.revisionNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"step_changed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — someone changed that step first; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.current.revisionNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names the version that holds it."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the body is not JSON, breaks the schema, or names an unknown field (a tier or an account included). Or the change cannot apply: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.opIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expected_revision_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_organization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_row"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_step"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_assignee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_transition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blocked_reason_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list_full"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A ceiling was reached: the per-minute request limit ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the per-key day ceiling of 200 runs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.resets_in_seconds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or the product's own daily model budget ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget_exhausted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fails closed, nothing spent: no database ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"database_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or no usable model provider ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"}],"pointer":"/paths/~1api~1v1~1lists/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_18","exampleIds":["paths/~1api~1v1~1lists/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_18","exampleIds":["paths/~1api~1v1~1lists/post/responses/200/content/application~1json/example"]}}},{"code":"201","schemaId":"schema_18","exampleIds":["paths/~1api~1v1~1lists/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_18","exampleIds":["paths/~1api~1v1~1lists/post/responses/201/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"403","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"404","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"409","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"422","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"429","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"503","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/lists/createlist"}],"panels":[]}]},"httpPath":"/api/v1/lists"},{"label":"Read a List and a page of its rows","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/lists/readlist","routeSlug":"/docs/openapi/lists/readlist","metadata":{"seo":{"title":"Read a List and a page of its rows","description":"One List and a page of its rows: each organization's name, address and when it was added. Use this when you have a List's id and need the organizations on it. Rows are in the order they were added. An unknown id and another account's List are the same 404."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"readList","name":"Read a List and a page of its rows","isWebhook":false,"pointer":"/paths/~1api~1v1~1lists~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Read a List and a page of its rows","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One List and a page of its rows: each organization's name, address and when it was added. Use this when you have a List's id and need the organizations on it. Rows are in the order they were added. An unknown id and another account's List are the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hck_live_..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Scopes are per key: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contracts:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"market:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent:ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1lists~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_12"},{"name":"limit","in":"query","schemaId":"schema_13"}],"pointer":"/paths/~1api~1v1~1lists~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/lists/{id}","servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_12"},{"name":"limit","in":"query","required":false,"schemaId":"schema_13"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404","422","429","503"],"pointer":"/api/v1/lists/{id}","href":"lists/readlist","openApiOperationId":"readList","summary":"Read a List and a page of its rows"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Done.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19","exampleIds":["paths/~1api~1v1~1lists~1{id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_19","exampleIds":["paths/~1api~1v1~1lists~1{id}/get/responses/200/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_or_malformed_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, or one that is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a valid key sent any other way lands here. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a well-formed key we do not hold, or a revoked one. The message names which."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key lacks the scope this route requires; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insufficient_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No such record. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The query string did not parse; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the issues. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_query"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A ceiling was reached: the per-minute request limit ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the per-key day ceiling of 200 runs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.resets_in_seconds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or the product's own daily model budget ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget_exhausted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fails closed, nothing spent: no database ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"database_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or no usable model provider ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"}],"pointer":"/paths/~1api~1v1~1lists~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_19","exampleIds":["paths/~1api~1v1~1lists~1{id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19","exampleIds":["paths/~1api~1v1~1lists~1{id}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"403","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"404","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"422","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"429","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"503","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/lists/readlist"}],"panels":[]}]},"httpPath":"/api/v1/lists/{id}"},{"label":"Rename a List","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/lists/renamelist","routeSlug":"/docs/openapi/lists/renamelist","metadata":{"seo":{"title":"Rename a List","description":"Give a List a new name. Nothing else about it changes. Use this when someone asks to rename a List. Changes the name and nothing else, as one new version."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"renameList","name":"Rename a List","isWebhook":false,"pointer":"/paths/~1api~1v1~1lists~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rename a List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Give a List a new name. Nothing else about it changes. Use this when someone asks to rename a List. Changes the name and nothing else, as one new version."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hck_live_..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Scopes are per key: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contracts:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"market:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent:ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1lists~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_16","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 to 128 characters. A retry with the same key and body returns the first result; the same key with another body is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1v1~1lists~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_20","exampleIds":["paths/~1api~1v1~1lists~1{id}/patch/requestBody/content/application~1json/example"]}},"schemaId":"schema_20","exampleIds":["paths/~1api~1v1~1lists~1{id}/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1lists~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/lists/{id}","servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_16"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_20","exampleIds":["paths/~1api~1v1~1lists~1{id}/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","401","403","404","409","422","429","503"],"pointer":"/api/v1/lists/{id}","href":"lists/renamelist","openApiOperationId":"renameList","summary":"Rename a List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"schemaId":"schema_20","exampleIds":["paths/~1api~1v1~1lists~1{id}/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_20","exampleIds":["paths/~1api~1v1~1lists~1{id}/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Done.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_18","exampleIds":["paths/~1api~1v1~1lists~1{id}/patch/responses/200/content/application~1json/example"]}},"schemaId":"schema_18","exampleIds":["paths/~1api~1v1~1lists~1{id}/patch/responses/200/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_or_malformed_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, or one that is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a valid key sent any other way lands here. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a well-formed key we do not hold, or a revoked one. The message names which."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insufficient_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the key lacks this route's scope; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"owner_only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — only the owner can archive. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — restore it in the app before changing it."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No such record. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idempotency_conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Idempotency-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was used for a different request; send a new key. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revision_conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — someone saved a newer version; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.current.revisionNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"step_changed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — someone changed that step first; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.current.revisionNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names the version that holds it."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the body is not JSON, breaks the schema, or names an unknown field (a tier or an account included). Or the change cannot apply: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.opIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expected_revision_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_organization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_row"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_step"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_assignee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_transition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blocked_reason_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list_full"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A ceiling was reached: the per-minute request limit ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the per-key day ceiling of 200 runs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.resets_in_seconds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or the product's own daily model budget ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget_exhausted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fails closed, nothing spent: no database ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"database_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or no usable model provider ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"}],"pointer":"/paths/~1api~1v1~1lists~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_18","exampleIds":["paths/~1api~1v1~1lists~1{id}/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_18","exampleIds":["paths/~1api~1v1~1lists~1{id}/patch/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"403","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"404","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"409","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"422","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"429","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"503","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/lists/renamelist"}],"panels":[]}]},"httpPath":"/api/v1/lists/{id}"},{"label":"Add or remove organizations on a List","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/lists/changelistrows","routeSlug":"/docs/openapi/lists/changelistrows","metadata":{"seo":{"title":"Add or remove organizations on a List","description":"Add organizations to a List, take them off, or both, by their ids. Use this when someone asks to change which organizations are on a List. Send add, remove or both; all of it is one new version. An organization already on the List is counted, not added twice; one that is not on it cannot be removed (422 unknown_row). Adding needs no version; a removal is checked against the version current when it arrives."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"changeListRows","name":"Add or remove organizations on a List","isWebhook":false,"pointer":"/paths/~1api~1v1~1lists~1{id}~1rows/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add or remove organizations on a List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add organizations to a List, take them off, or both, by their ids. Use this when someone asks to change which organizations are on a List. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"add"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"remove"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or both; all of it is one new version. An organization already on the List is counted, not added twice; one that is not on it cannot be removed ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422 unknown_row"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Adding needs no version; a removal is checked against the version current when it arrives."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hck_live_..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Scopes are per key: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contracts:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"market:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent:ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1lists~1{id}~1rows/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_16","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 to 128 characters. A retry with the same key and body returns the first result; the same key with another body is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1v1~1lists~1{id}~1rows/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_21","exampleIds":["paths/~1api~1v1~1lists~1{id}~1rows/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_21","exampleIds":["paths/~1api~1v1~1lists~1{id}~1rows/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1lists~1{id}~1rows/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/lists/{id}/rows","servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_16"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_21","exampleIds":["paths/~1api~1v1~1lists~1{id}~1rows/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","401","403","404","409","422","429","503"],"pointer":"/api/v1/lists/{id}/rows","href":"lists/changelistrows","openApiOperationId":"changeListRows","summary":"Add or remove organizations on a List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"schemaId":"schema_21","exampleIds":["paths/~1api~1v1~1lists~1{id}~1rows/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_21","exampleIds":["paths/~1api~1v1~1lists~1{id}~1rows/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Done.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_18","exampleIds":["paths/~1api~1v1~1lists~1{id}~1rows/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_18","exampleIds":["paths/~1api~1v1~1lists~1{id}~1rows/post/responses/200/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_or_malformed_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, or one that is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a valid key sent any other way lands here. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a well-formed key we do not hold, or a revoked one. The message names which."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insufficient_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the key lacks this route's scope; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"owner_only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — only the owner can archive. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — restore it in the app before changing it."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No such record. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idempotency_conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Idempotency-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was used for a different request; send a new key. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revision_conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — someone saved a newer version; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.current.revisionNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"step_changed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — someone changed that step first; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.current.revisionNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names the version that holds it."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the body is not JSON, breaks the schema, or names an unknown field (a tier or an account included). Or the change cannot apply: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.opIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expected_revision_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_organization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_row"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_step"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_assignee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_transition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blocked_reason_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list_full"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A ceiling was reached: the per-minute request limit ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the per-key day ceiling of 200 runs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.resets_in_seconds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or the product's own daily model budget ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget_exhausted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fails closed, nothing spent: no database ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"database_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or no usable model provider ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"}],"pointer":"/paths/~1api~1v1~1lists~1{id}~1rows/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_18","exampleIds":["paths/~1api~1v1~1lists~1{id}~1rows/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_18","exampleIds":["paths/~1api~1v1~1lists~1{id}~1rows/post/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"403","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"404","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"409","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"422","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"429","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"503","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/lists/changelistrows"}],"panels":[]}]},"httpPath":"/api/v1/lists/{id}/rows"},{"label":"Archive a List","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/lists/archivelist","routeSlug":"/docs/openapi/lists/archivelist","metadata":{"seo":{"title":"Archive a List","description":"Archive a List, which is how a List is deleted. It leaves every list view; the app can restore it. Use this when someone asks to delete or archive a List. Archiving is how a List is deleted; the owner may restore it in the app. Only the owner may archive (403 owner_only)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"archiveList","name":"Archive a List","isWebhook":false,"pointer":"/paths/~1api~1v1~1lists~1{id}~1archive/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Archive a List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Archive a List, which is how a List is deleted. It leaves every list view; the app can restore it. Use this when someone asks to delete or archive a List. Archiving is how a List is deleted; the owner may restore it in the app. Only the owner may archive ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403 owner_only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hck_live_..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Scopes are per key: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contracts:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"market:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent:ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1lists~1{id}~1archive/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_16","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 to 128 characters. A retry with the same key and body returns the first result; the same key with another body is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1v1~1lists~1{id}~1archive/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_22","exampleIds":["paths/~1api~1v1~1lists~1{id}~1archive/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_22","exampleIds":["paths/~1api~1v1~1lists~1{id}~1archive/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1lists~1{id}~1archive/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/lists/{id}/archive","servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_16"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_22","exampleIds":["paths/~1api~1v1~1lists~1{id}~1archive/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","401","403","404","409","422","429","503"],"pointer":"/api/v1/lists/{id}/archive","href":"lists/archivelist","openApiOperationId":"archiveList","summary":"Archive a List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"schemaId":"schema_22","exampleIds":["paths/~1api~1v1~1lists~1{id}~1archive/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_22","exampleIds":["paths/~1api~1v1~1lists~1{id}~1archive/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Done.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_18","exampleIds":["paths/~1api~1v1~1lists~1{id}~1archive/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_18","exampleIds":["paths/~1api~1v1~1lists~1{id}~1archive/post/responses/200/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_or_malformed_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, or one that is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a valid key sent any other way lands here. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a well-formed key we do not hold, or a revoked one. The message names which."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insufficient_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the key lacks this route's scope; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"owner_only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — only the owner can archive. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — restore it in the app before changing it."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No such record. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idempotency_conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Idempotency-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was used for a different request; send a new key. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revision_conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — someone saved a newer version; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.current.revisionNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"step_changed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — someone changed that step first; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.current.revisionNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names the version that holds it."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the body is not JSON, breaks the schema, or names an unknown field (a tier or an account included). Or the change cannot apply: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.opIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expected_revision_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_organization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_row"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_step"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_assignee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_transition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blocked_reason_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list_full"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A ceiling was reached: the per-minute request limit ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the per-key day ceiling of 200 runs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.resets_in_seconds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or the product's own daily model budget ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget_exhausted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fails closed, nothing spent: no database ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"database_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or no usable model provider ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"}],"pointer":"/paths/~1api~1v1~1lists~1{id}~1archive/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_18","exampleIds":["paths/~1api~1v1~1lists~1{id}~1archive/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_18","exampleIds":["paths/~1api~1v1~1lists~1{id}~1archive/post/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"403","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"404","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"409","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"422","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"429","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"503","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/lists/archivelist"}],"panels":[]}]},"httpPath":"/api/v1/lists/{id}/archive"},{"label":"Download a List as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/lists/exportlist","routeSlug":"/docs/openapi/lists/exportlist","metadata":{"seo":{"title":"Download a List as CSV","description":"A List's rows as a CSV file, the same file the app downloads. Use this when someone wants the whole List in a spreadsheet or another tool. The same file the app downloads: one row per organization, with its note and priority."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"exportList","name":"Download a List as CSV","isWebhook":false,"pointer":"/paths/~1api~1v1~1lists~1{id}~1export.csv/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download a List as CSV","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"A List's rows as a CSV file, the same file the app downloads. Use this when someone wants the whole List in a spreadsheet or another tool. The same file the app downloads: one row per organization, with its note and priority."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hck_live_..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Scopes are per key: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contracts:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"market:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent:ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1lists~1{id}~1export.csv/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/lists/{id}/export.csv","servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404","422","429","503"],"pointer":"/api/v1/lists/{id}/export.csv","href":"lists/exportlist","openApiOperationId":"exportList","summary":"Download a List as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The CSV file.","mediaType":"text/csv","mediaTypes":["text/csv"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_0","exampleIds":["paths/~1api~1v1~1lists~1{id}~1export.csv/get/responses/200/content/text~1csv/example"]}},"schemaId":"schema_0","exampleIds":["paths/~1api~1v1~1lists~1{id}~1export.csv/get/responses/200/content/text~1csv/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_or_malformed_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, or one that is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a valid key sent any other way lands here. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a well-formed key we do not hold, or a revoked one. The message names which."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key lacks the scope this route requires; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insufficient_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No such record. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The query string did not parse; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the issues. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_query"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A ceiling was reached: the per-minute request limit ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the per-key day ceiling of 200 runs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.resets_in_seconds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or the product's own daily model budget ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget_exhausted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fails closed, nothing spent: no database ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"database_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or no usable model provider ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"}],"pointer":"/paths/~1api~1v1~1lists~1{id}~1export.csv/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_0","exampleIds":["paths/~1api~1v1~1lists~1{id}~1export.csv/get/responses/200/content/text~1csv/example"],"mediaTypes":["text/csv"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_0","exampleIds":["paths/~1api~1v1~1lists~1{id}~1export.csv/get/responses/200/content/text~1csv/example"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"403","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"404","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"422","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"429","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"503","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/lists/exportlist"}],"panels":[]}]},"httpPath":"/api/v1/lists/{id}/export.csv"}],"content":{"contentType":"group","meta":{"name":"lists"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"lists","showPageActions":true},{"nodeType":"markdoc","content":"Lists of organizations you save: list, read with rows, create, add and remove rows, rename, archive, export as CSV."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/lists","summary":"List your Lists","prefix":{"name":"get","color":"get"},"badges":[],"link":"/lists/listlists","deprecated":false},{"title":"/api/v1/lists","summary":"Make a List","prefix":{"name":"post","color":"post"},"badges":[],"link":"/lists/createlist","deprecated":false},{"title":"/api/v1/lists/{id}","summary":"Read a List and a page of its rows","prefix":{"name":"get","color":"get"},"badges":[],"link":"/lists/readlist","deprecated":false},{"title":"/api/v1/lists/{id}","summary":"Rename a List","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/lists/renamelist","deprecated":false},{"title":"/api/v1/lists/{id}/rows","summary":"Add or remove organizations on a List","prefix":{"name":"post","color":"post"},"badges":[],"link":"/lists/changelistrows","deprecated":false},{"title":"/api/v1/lists/{id}/archive","summary":"Archive a List","prefix":{"name":"post","color":"post"},"badges":[],"link":"/lists/archivelist","deprecated":false},{"title":"/api/v1/lists/{id}/export.csv","summary":"Download a List as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/lists/exportlist","deprecated":false}]}]}]}]}},{"type":"group","label":"actions","link":"/docs/openapi/actions","routeSlug":"/docs/openapi/actions","items":[{"label":"Your steps across every plan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/actions/mysteps","routeSlug":"/docs/openapi/actions/mysteps","metadata":{"seo":{"title":"Your steps across every plan","description":"Steps across all your plans in one page, with the total: filter by status, due date and who owns them. Use this when someone asks what is due, late or blocked, without reading each plan. One page with the counted total, soonest due first and undated last. dueBefore and dueAfter are inclusive; a step with no due date matches neither. assignee=me (the default) is steps assigned to you; any is every step of a plan you can read."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"mySteps","name":"Your steps across every plan","isWebhook":false,"pointer":"/paths/~1api~1v1~1actions~1steps/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Your steps across every plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Steps across all your plans in one page, with the total: filter by status, due date and who owns them. Use this when someone asks what is due, late or blocked, without reading each plan. One page with the counted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", soonest due first and undated last. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueBefore"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dueAfter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are inclusive; a step with no due date matches neither. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"assignee=me"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the default) is steps assigned to you; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"any"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is every step of a plan you can read."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hck_live_..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Scopes are per key: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contracts:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"market:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent:ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_12"},{"name":"limit","in":"query","schemaId":"schema_13"},{"name":"status","in":"query","schemaId":"schema_23"},{"name":"dueBefore","in":"query","schemaId":"schema_4"},{"name":"dueAfter","in":"query","schemaId":"schema_4"},{"name":"assignee","in":"query","schemaId":"schema_24"}],"pointer":"/paths/~1api~1v1~1actions~1steps/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/actions/steps","servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_12"},{"name":"limit","in":"query","required":false,"schemaId":"schema_13"},{"name":"status","in":"query","required":false,"schemaId":"schema_23","style":"form","explode":true},{"name":"dueBefore","in":"query","required":false,"schemaId":"schema_4"},{"name":"dueAfter","in":"query","required":false,"schemaId":"schema_4"},{"name":"assignee","in":"query","required":false,"schemaId":"schema_24"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404","422","429","503"],"pointer":"/api/v1/actions/steps","href":"actions/mysteps","openApiOperationId":"mySteps","summary":"Your steps across every plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Done.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1api~1v1~1actions~1steps/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_25","exampleIds":["paths/~1api~1v1~1actions~1steps/get/responses/200/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_or_malformed_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, or one that is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a valid key sent any other way lands here. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a well-formed key we do not hold, or a revoked one. The message names which."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key lacks the scope this route requires; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insufficient_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No such record. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The query string did not parse; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the issues. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_query"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A ceiling was reached: the per-minute request limit ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the per-key day ceiling of 200 runs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.resets_in_seconds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or the product's own daily model budget ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget_exhausted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fails closed, nothing spent: no database ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"database_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or no usable model provider ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"}],"pointer":"/paths/~1api~1v1~1actions~1steps/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_25","exampleIds":["paths/~1api~1v1~1actions~1steps/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1api~1v1~1actions~1steps/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"403","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"404","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"422","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"429","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"503","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/actions/mysteps"}],"panels":[]}]},"httpPath":"/api/v1/actions/steps"},{"label":"List your action plans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/actions/listplans","routeSlug":"/docs/openapi/actions/listplans","metadata":{"seo":{"title":"List your action plans","description":"Your action plans, newest change first, without their steps. Use this when you need a plan's id, or want to see which plans exist. Newest change first, without steps. total is null: this read does not count."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPlans","name":"List your action plans","isWebhook":false,"pointer":"/paths/~1api~1v1~1actions~1plans/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List your action plans","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your action plans, newest change first, without their steps. Use this when you need a plan's id, or want to see which plans exist. Newest change first, without steps. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is null: this read does not count."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hck_live_..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Scopes are per key: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contracts:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"market:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent:ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_12"},{"name":"limit","in":"query","schemaId":"schema_13"}],"pointer":"/paths/~1api~1v1~1actions~1plans/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/actions/plans","servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_12"},{"name":"limit","in":"query","required":false,"schemaId":"schema_13"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404","422","429","503"],"pointer":"/api/v1/actions/plans","href":"actions/listplans","openApiOperationId":"listPlans","summary":"List your action plans"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Done.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26","exampleIds":["paths/~1api~1v1~1actions~1plans/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_26","exampleIds":["paths/~1api~1v1~1actions~1plans/get/responses/200/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_or_malformed_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, or one that is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a valid key sent any other way lands here. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a well-formed key we do not hold, or a revoked one. The message names which."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key lacks the scope this route requires; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insufficient_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No such record. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The query string did not parse; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the issues. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_query"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A ceiling was reached: the per-minute request limit ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the per-key day ceiling of 200 runs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.resets_in_seconds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or the product's own daily model budget ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget_exhausted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fails closed, nothing spent: no database ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"database_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or no usable model provider ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"}],"pointer":"/paths/~1api~1v1~1actions~1plans/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_26","exampleIds":["paths/~1api~1v1~1actions~1plans/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26","exampleIds":["paths/~1api~1v1~1actions~1plans/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"403","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"404","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"422","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"429","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"503","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/actions/listplans"}],"panels":[]}]},"httpPath":"/api/v1/actions/plans"},{"label":"Make an action plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/actions/createplan","routeSlug":"/docs/openapi/actions/createplan","metadata":{"seo":{"title":"Make an action plan","description":"Make a new action plan with its steps. Send an Idempotency-Key so a retry makes one plan, not two. Use this when someone asks to plan the work for an account or a pursuit. Answers 201 with the plan; the same Idempotency-Key and body again answers 200 with the same id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPlan","name":"Make an action plan","isWebhook":false,"pointer":"/paths/~1api~1v1~1actions~1plans/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Make an action plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Make a new action plan with its steps. Send an Idempotency-Key so a retry makes one plan, not two. Use this when someone asks to plan the work for an account or a pursuit. Answers "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the plan; the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Idempotency-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and body again answers "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the same id."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hck_live_..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Scopes are per key: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contracts:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"market:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent:ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_16","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 to 128 characters. A retry with the same key and body returns the first result; the same key with another body is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1v1~1actions~1plans/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_27","exampleIds":["paths/~1api~1v1~1actions~1plans/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_27","exampleIds":["paths/~1api~1v1~1actions~1plans/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1actions~1plans/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/actions/plans","servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_16"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_27","exampleIds":["paths/~1api~1v1~1actions~1plans/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","201","401","403","404","409","422","429","503"],"pointer":"/api/v1/actions/plans","href":"actions/createplan","openApiOperationId":"createPlan","summary":"Make an action plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"schemaId":"schema_27","exampleIds":["paths/~1api~1v1~1actions~1plans/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_27","exampleIds":["paths/~1api~1v1~1actions~1plans/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A retry: the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Idempotency-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and body as a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before it; the same id."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28","exampleIds":["paths/~1api~1v1~1actions~1plans/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_28","exampleIds":["paths/~1api~1v1~1actions~1plans/post/responses/200/content/application~1json/example"]},{"code":"201","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Made; a retry with the same key and body answers "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the same id."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28","exampleIds":["paths/~1api~1v1~1actions~1plans/post/responses/201/content/application~1json/example"]}},"schemaId":"schema_28","exampleIds":["paths/~1api~1v1~1actions~1plans/post/responses/201/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_or_malformed_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, or one that is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a valid key sent any other way lands here. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a well-formed key we do not hold, or a revoked one. The message names which."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insufficient_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the key lacks this route's scope; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"owner_only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — only the owner can archive. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — restore it in the app before changing it."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No such record. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idempotency_conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Idempotency-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was used for a different request; send a new key. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revision_conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — someone saved a newer version; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.current.revisionNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"step_changed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — someone changed that step first; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.current.revisionNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names the version that holds it."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the body is not JSON, breaks the schema, or names an unknown field (a tier or an account included). Or the change cannot apply: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.opIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expected_revision_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_organization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_row"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_step"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_assignee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_transition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blocked_reason_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list_full"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A ceiling was reached: the per-minute request limit ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the per-key day ceiling of 200 runs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.resets_in_seconds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or the product's own daily model budget ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget_exhausted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fails closed, nothing spent: no database ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"database_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or no usable model provider ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"}],"pointer":"/paths/~1api~1v1~1actions~1plans/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_28","exampleIds":["paths/~1api~1v1~1actions~1plans/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28","exampleIds":["paths/~1api~1v1~1actions~1plans/post/responses/200/content/application~1json/example"]}}},{"code":"201","schemaId":"schema_28","exampleIds":["paths/~1api~1v1~1actions~1plans/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28","exampleIds":["paths/~1api~1v1~1actions~1plans/post/responses/201/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"403","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"404","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"409","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"422","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"429","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"503","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/actions/createplan"}],"panels":[]}]},"httpPath":"/api/v1/actions/plans"},{"label":"Read an action plan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/actions/readplan","routeSlug":"/docs/openapi/actions/readplan","metadata":{"seo":{"title":"Read an action plan","description":"One action plan with every step: its status, owner, due date and why it is blocked. Use this when you have a plan's id and need its steps. Every step, in order, with its status, owner, due date and why it is blocked."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"readPlan","name":"Read an action plan","isWebhook":false,"pointer":"/paths/~1api~1v1~1actions~1plans~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Read an action plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"One action plan with every step: its status, owner, due date and why it is blocked. Use this when you have a plan's id and need its steps. Every step, in order, with its status, owner, due date and why it is blocked."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hck_live_..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Scopes are per key: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contracts:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"market:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent:ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1actions~1plans~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/actions/plans/{id}","servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404","422","429","503"],"pointer":"/api/v1/actions/plans/{id}","href":"actions/readplan","openApiOperationId":"readPlan","summary":"Read an action plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Done.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28","exampleIds":["paths/~1api~1v1~1actions~1plans~1{id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_28","exampleIds":["paths/~1api~1v1~1actions~1plans~1{id}/get/responses/200/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_or_malformed_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, or one that is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a valid key sent any other way lands here. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a well-formed key we do not hold, or a revoked one. The message names which."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key lacks the scope this route requires; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insufficient_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No such record. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The query string did not parse; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the issues. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_query"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A ceiling was reached: the per-minute request limit ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the per-key day ceiling of 200 runs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.resets_in_seconds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or the product's own daily model budget ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget_exhausted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fails closed, nothing spent: no database ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"database_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or no usable model provider ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"}],"pointer":"/paths/~1api~1v1~1actions~1plans~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_28","exampleIds":["paths/~1api~1v1~1actions~1plans~1{id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28","exampleIds":["paths/~1api~1v1~1actions~1plans~1{id}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"403","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"404","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"422","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"429","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"503","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/actions/readplan"}],"panels":[]}]},"httpPath":"/api/v1/actions/plans/{id}"},{"label":"Change an action plan","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/actions/editplan","routeSlug":"/docs/openapi/actions/editplan","metadata":{"seo":{"title":"Change an action plan","description":"Change a plan: add, edit, reorder or remove steps, or rename it, in one version. Send the version you read; a newer one is a conflict carrying it. Use this when someone asks to change a plan's steps. ops are the plan's own operations, applied as one new version: add_step, update_step, remove_step, move_step, set_step_status and set_field (title, objective). expectedRevisionNo is required for a plan; a newer version is 409 revision_conflict carrying it."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"editPlan","name":"Change an action plan","isWebhook":false,"pointer":"/paths/~1api~1v1~1actions~1plans~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change an action plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Change a plan: add, edit, reorder or remove steps, or rename it, in one version. Send the version you read; a newer one is a conflict carrying it. Use this when someone asks to change a plan's steps. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ops"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are the plan's own operations, applied as one new version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"add_step"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"update_step"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"remove_step"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"move_step"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"set_step_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"set_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objective"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expectedRevisionNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required for a plan; a newer version is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409 revision_conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carrying it."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hck_live_..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Scopes are per key: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contracts:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"market:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent:ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1actions~1plans~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_16","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 to 128 characters. A retry with the same key and body returns the first result; the same key with another body is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1v1~1actions~1plans~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_29","exampleIds":["paths/~1api~1v1~1actions~1plans~1{id}/patch/requestBody/content/application~1json/example"]}},"schemaId":"schema_29","exampleIds":["paths/~1api~1v1~1actions~1plans~1{id}/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1actions~1plans~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/actions/plans/{id}","servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_16"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_29","exampleIds":["paths/~1api~1v1~1actions~1plans~1{id}/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","401","403","404","409","422","429","503"],"pointer":"/api/v1/actions/plans/{id}","href":"actions/editplan","openApiOperationId":"editPlan","summary":"Change an action plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"schemaId":"schema_29","exampleIds":["paths/~1api~1v1~1actions~1plans~1{id}/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_29","exampleIds":["paths/~1api~1v1~1actions~1plans~1{id}/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Done.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28","exampleIds":["paths/~1api~1v1~1actions~1plans~1{id}/patch/responses/200/content/application~1json/example"]}},"schemaId":"schema_28","exampleIds":["paths/~1api~1v1~1actions~1plans~1{id}/patch/responses/200/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_or_malformed_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, or one that is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a valid key sent any other way lands here. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a well-formed key we do not hold, or a revoked one. The message names which."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insufficient_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the key lacks this route's scope; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"owner_only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — only the owner can archive. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — restore it in the app before changing it."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No such record. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idempotency_conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Idempotency-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was used for a different request; send a new key. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revision_conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — someone saved a newer version; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.current.revisionNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"step_changed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — someone changed that step first; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.current.revisionNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names the version that holds it."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the body is not JSON, breaks the schema, or names an unknown field (a tier or an account included). Or the change cannot apply: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.opIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expected_revision_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_organization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_row"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_step"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_assignee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_transition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blocked_reason_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list_full"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A ceiling was reached: the per-minute request limit ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the per-key day ceiling of 200 runs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.resets_in_seconds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or the product's own daily model budget ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget_exhausted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fails closed, nothing spent: no database ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"database_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or no usable model provider ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"}],"pointer":"/paths/~1api~1v1~1actions~1plans~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_28","exampleIds":["paths/~1api~1v1~1actions~1plans~1{id}/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28","exampleIds":["paths/~1api~1v1~1actions~1plans~1{id}/patch/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"403","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"404","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"409","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"422","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"429","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"503","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/actions/editplan"}],"panels":[]}]},"httpPath":"/api/v1/actions/plans/{id}"},{"label":"Move a step to a new status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/actions/setstepstatus","routeSlug":"/docs/openapi/actions/setstepstatus","metadata":{"seo":{"title":"Move a step to a new status","description":"Move one step to a new status, such as done or blocked (blocked needs a reason). No version id is needed; it refuses only if that step changed first. Use this when someone finishes or is stuck on a step. No version is sent: a change someone else saved first is kept, and this one is applied over it, unless they changed this step, which is 409 step_changed. blocked needs blockedReason."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"setStepStatus","name":"Move a step to a new status","isWebhook":false,"pointer":"/paths/~1api~1v1~1actions~1plans~1{id}~1steps~1{stepId}~1status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Move a step to a new status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Move one step to a new status, such as done or blocked (blocked needs a reason). No version id is needed; it refuses only if that step changed first. Use this when someone finishes or is stuck on a step. No version is sent: a change someone else saved first is kept, and this one is applied over it, unless they changed this step, which is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409 step_changed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blocked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" needs "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blockedReason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hck_live_..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Scopes are per key: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contracts:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"market:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent:ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true},{"name":"stepId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1actions~1plans~1{id}~1steps~1{stepId}~1status/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_16","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 to 128 characters. A retry with the same key and body returns the first result; the same key with another body is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1v1~1actions~1plans~1{id}~1steps~1{stepId}~1status/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_30","exampleIds":["paths/~1api~1v1~1actions~1plans~1{id}~1steps~1{stepId}~1status/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_30","exampleIds":["paths/~1api~1v1~1actions~1plans~1{id}~1steps~1{stepId}~1status/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1actions~1plans~1{id}~1steps~1{stepId}~1status/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/actions/plans/{id}/steps/{stepId}/status","servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"},{"name":"stepId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_16"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_30","exampleIds":["paths/~1api~1v1~1actions~1plans~1{id}~1steps~1{stepId}~1status/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","401","403","404","409","422","429","503"],"pointer":"/api/v1/actions/plans/{id}/steps/{stepId}/status","href":"actions/setstepstatus","openApiOperationId":"setStepStatus","summary":"Move a step to a new status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"schemaId":"schema_30","exampleIds":["paths/~1api~1v1~1actions~1plans~1{id}~1steps~1{stepId}~1status/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_30","exampleIds":["paths/~1api~1v1~1actions~1plans~1{id}~1steps~1{stepId}~1status/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Done.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28","exampleIds":["paths/~1api~1v1~1actions~1plans~1{id}~1steps~1{stepId}~1status/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_28","exampleIds":["paths/~1api~1v1~1actions~1plans~1{id}~1steps~1{stepId}~1status/post/responses/200/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_or_malformed_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, or one that is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a valid key sent any other way lands here. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a well-formed key we do not hold, or a revoked one. The message names which."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insufficient_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the key lacks this route's scope; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"owner_only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — only the owner can archive. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — restore it in the app before changing it."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No such record. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idempotency_conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Idempotency-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was used for a different request; send a new key. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revision_conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — someone saved a newer version; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.current.revisionNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"step_changed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — someone changed that step first; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.current.revisionNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names the version that holds it."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the body is not JSON, breaks the schema, or names an unknown field (a tier or an account included). Or the change cannot apply: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.opIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expected_revision_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_organization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_row"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_step"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_assignee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_transition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blocked_reason_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list_full"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A ceiling was reached: the per-minute request limit ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the per-key day ceiling of 200 runs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.resets_in_seconds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or the product's own daily model budget ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget_exhausted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fails closed, nothing spent: no database ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"database_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or no usable model provider ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"}],"pointer":"/paths/~1api~1v1~1actions~1plans~1{id}~1steps~1{stepId}~1status/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_28","exampleIds":["paths/~1api~1v1~1actions~1plans~1{id}~1steps~1{stepId}~1status/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28","exampleIds":["paths/~1api~1v1~1actions~1plans~1{id}~1steps~1{stepId}~1status/post/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"403","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"404","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"409","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"422","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"429","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"503","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/actions/setstepstatus"}],"panels":[]}]},"httpPath":"/api/v1/actions/plans/{id}/steps/{stepId}/status"},{"label":"Archive an action plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/actions/archiveplan","routeSlug":"/docs/openapi/actions/archiveplan","metadata":{"seo":{"title":"Archive an action plan","description":"Archive an action plan, which is how a plan is deleted; its steps leave every step list. Use this when someone asks to delete or archive a plan. Archiving is how a plan is deleted; its steps leave every step list at once."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"archivePlan","name":"Archive an action plan","isWebhook":false,"pointer":"/paths/~1api~1v1~1actions~1plans~1{id}~1archive/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Archive an action plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Archive an action plan, which is how a plan is deleted; its steps leave every step list. Use this when someone asks to delete or archive a plan. Archiving is how a plan is deleted; its steps leave every step list at once."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hck_live_..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Scopes are per key: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contracts:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"market:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent:ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1actions~1plans~1{id}~1archive/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_16","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 to 128 characters. A retry with the same key and body returns the first result; the same key with another body is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1v1~1actions~1plans~1{id}~1archive/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_22","exampleIds":["paths/~1api~1v1~1actions~1plans~1{id}~1archive/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_22","exampleIds":["paths/~1api~1v1~1actions~1plans~1{id}~1archive/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1actions~1plans~1{id}~1archive/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/actions/plans/{id}/archive","servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_16"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_22","exampleIds":["paths/~1api~1v1~1actions~1plans~1{id}~1archive/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","401","403","404","409","422","429","503"],"pointer":"/api/v1/actions/plans/{id}/archive","href":"actions/archiveplan","openApiOperationId":"archivePlan","summary":"Archive an action plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"schemaId":"schema_22","exampleIds":["paths/~1api~1v1~1actions~1plans~1{id}~1archive/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_22","exampleIds":["paths/~1api~1v1~1actions~1plans~1{id}~1archive/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Done.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28","exampleIds":["paths/~1api~1v1~1actions~1plans~1{id}~1archive/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_28","exampleIds":["paths/~1api~1v1~1actions~1plans~1{id}~1archive/post/responses/200/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_or_malformed_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, or one that is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a valid key sent any other way lands here. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a well-formed key we do not hold, or a revoked one. The message names which."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insufficient_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the key lacks this route's scope; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"owner_only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — only the owner can archive. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — restore it in the app before changing it."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No such record. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idempotency_conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Idempotency-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was used for a different request; send a new key. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revision_conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — someone saved a newer version; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.current.revisionNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"step_changed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — someone changed that step first; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.current.revisionNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names the version that holds it."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the body is not JSON, breaks the schema, or names an unknown field (a tier or an account included). Or the change cannot apply: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.opIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expected_revision_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_organization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_row"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_step"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_assignee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_transition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blocked_reason_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list_full"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A ceiling was reached: the per-minute request limit ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the per-key day ceiling of 200 runs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.resets_in_seconds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or the product's own daily model budget ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget_exhausted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fails closed, nothing spent: no database ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"database_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or no usable model provider ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"}],"pointer":"/paths/~1api~1v1~1actions~1plans~1{id}~1archive/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_28","exampleIds":["paths/~1api~1v1~1actions~1plans~1{id}~1archive/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28","exampleIds":["paths/~1api~1v1~1actions~1plans~1{id}~1archive/post/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"403","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"404","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"409","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"422","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"429","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"503","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/actions/archiveplan"}],"panels":[]}]},"httpPath":"/api/v1/actions/plans/{id}/archive"}],"content":{"contentType":"group","meta":{"name":"actions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"actions","showPageActions":true},{"nodeType":"markdoc","content":"Action plans and their steps: your steps across every plan in one call, a step's status, and plans to read, create, edit and archive."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/actions/steps","summary":"Your steps across every plan","prefix":{"name":"get","color":"get"},"badges":[],"link":"/actions/mysteps","deprecated":false},{"title":"/api/v1/actions/plans","summary":"List your action plans","prefix":{"name":"get","color":"get"},"badges":[],"link":"/actions/listplans","deprecated":false},{"title":"/api/v1/actions/plans","summary":"Make an action plan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/actions/createplan","deprecated":false},{"title":"/api/v1/actions/plans/{id}","summary":"Read an action plan","prefix":{"name":"get","color":"get"},"badges":[],"link":"/actions/readplan","deprecated":false},{"title":"/api/v1/actions/plans/{id}","summary":"Change an action plan","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/actions/editplan","deprecated":false},{"title":"/api/v1/actions/plans/{id}/steps/{stepId}/status","summary":"Move a step to a new status","prefix":{"name":"post","color":"post"},"badges":[],"link":"/actions/setstepstatus","deprecated":false},{"title":"/api/v1/actions/plans/{id}/archive","summary":"Archive an action plan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/actions/archiveplan","deprecated":false}]}]}]}]}},{"type":"group","label":"drafts","link":"/docs/openapi/drafts","routeSlug":"/docs/openapi/drafts","items":[{"label":"List your drafts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/drafts/listdrafts","routeSlug":"/docs/openapi/drafts/listdrafts","metadata":{"seo":{"title":"List your drafts","description":"Your drafts, newest change first, without their text. Use this when you need a draft's id, or want to see which drafts exist or are approved. Newest change first, without their text. approved=true keeps only approved drafts, approved=false only the rest. total is null: this read does not count."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listDrafts","name":"List your drafts","isWebhook":false,"pointer":"/paths/~1api~1v1~1drafts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List your drafts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your drafts, newest change first, without their text. Use this when you need a draft's id, or want to see which drafts exist or are approved. Newest change first, without their text. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"approved=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" keeps only approved drafts, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"approved=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only the rest. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is null: this read does not count."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hck_live_..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Scopes are per key: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contracts:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"market:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent:ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_12"},{"name":"limit","in":"query","schemaId":"schema_13"},{"name":"approved","in":"query","schemaId":"schema_5"}],"pointer":"/paths/~1api~1v1~1drafts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/drafts","servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_12"},{"name":"limit","in":"query","required":false,"schemaId":"schema_13"},{"name":"approved","in":"query","required":false,"schemaId":"schema_5"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404","422","429","503"],"pointer":"/api/v1/drafts","href":"drafts/listdrafts","openApiOperationId":"listDrafts","summary":"List your drafts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Done.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_31","exampleIds":["paths/~1api~1v1~1drafts/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_31","exampleIds":["paths/~1api~1v1~1drafts/get/responses/200/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_or_malformed_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, or one that is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a valid key sent any other way lands here. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a well-formed key we do not hold, or a revoked one. The message names which."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key lacks the scope this route requires; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insufficient_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No such record. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The query string did not parse; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the issues. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_query"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A ceiling was reached: the per-minute request limit ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the per-key day ceiling of 200 runs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.resets_in_seconds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or the product's own daily model budget ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget_exhausted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fails closed, nothing spent: no database ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"database_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or no usable model provider ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"}],"pointer":"/paths/~1api~1v1~1drafts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_31","exampleIds":["paths/~1api~1v1~1drafts/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_31","exampleIds":["paths/~1api~1v1~1drafts/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"403","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"404","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"422","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"429","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"503","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/drafts/listdrafts"}],"panels":[]}]},"httpPath":"/api/v1/drafts"},{"label":"Save a draft","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/drafts/createdraft","routeSlug":"/docs/openapi/drafts/createdraft","metadata":{"seo":{"title":"Save a draft","description":"Save a draft someone wrote, such as an email: its subject and body. It is recorded as their own text. Send an Idempotency-Key so a retry saves one draft. Use this when someone asks to keep a draft in HRC Ledger. The subject is saved as the draft's title and the body as its one section. It is recorded as the key holder's own text with the key, never as written by the assistant. Answers 201 with the draft; the same Idempotency-Key and body again answers 200 with the same id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createDraft","name":"Save a draft","isWebhook":false,"pointer":"/paths/~1api~1v1~1drafts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Save a draft","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Save a draft someone wrote, such as an email: its subject and body. It is recorded as their own text. Send an Idempotency-Key so a retry saves one draft. Use this when someone asks to keep a draft in HRC Ledger. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is saved as the draft's title and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as its one section. It is recorded as the key holder's own text with the key, never as written by the assistant. Answers "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the draft; the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Idempotency-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and body again answers "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the same id."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hck_live_..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Scopes are per key: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contracts:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"market:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent:ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_16","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 to 128 characters. A retry with the same key and body returns the first result; the same key with another body is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1v1~1drafts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_32","exampleIds":["paths/~1api~1v1~1drafts/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_32","exampleIds":["paths/~1api~1v1~1drafts/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1drafts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/drafts","servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_16"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_32","exampleIds":["paths/~1api~1v1~1drafts/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","201","401","403","404","409","422","429","503"],"pointer":"/api/v1/drafts","href":"drafts/createdraft","openApiOperationId":"createDraft","summary":"Save a draft"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"schemaId":"schema_32","exampleIds":["paths/~1api~1v1~1drafts/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_32","exampleIds":["paths/~1api~1v1~1drafts/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A retry: the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Idempotency-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and body as a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before it; the same id."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33","exampleIds":["paths/~1api~1v1~1drafts/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_33","exampleIds":["paths/~1api~1v1~1drafts/post/responses/200/content/application~1json/example"]},{"code":"201","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Made; a retry with the same key and body answers "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the same id."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33","exampleIds":["paths/~1api~1v1~1drafts/post/responses/201/content/application~1json/example"]}},"schemaId":"schema_33","exampleIds":["paths/~1api~1v1~1drafts/post/responses/201/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_or_malformed_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, or one that is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a valid key sent any other way lands here. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a well-formed key we do not hold, or a revoked one. The message names which."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insufficient_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the key lacks this route's scope; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"owner_only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — only the owner can archive. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — restore it in the app before changing it."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No such record. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idempotency_conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Idempotency-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was used for a different request; send a new key. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revision_conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — someone saved a newer version; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.current.revisionNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"step_changed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — someone changed that step first; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.current.revisionNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names the version that holds it."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the body is not JSON, breaks the schema, or names an unknown field (a tier or an account included). Or the change cannot apply: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.opIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expected_revision_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_organization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_row"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_step"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_assignee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_transition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blocked_reason_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list_full"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A ceiling was reached: the per-minute request limit ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the per-key day ceiling of 200 runs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.resets_in_seconds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or the product's own daily model budget ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget_exhausted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fails closed, nothing spent: no database ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"database_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or no usable model provider ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"}],"pointer":"/paths/~1api~1v1~1drafts/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_33","exampleIds":["paths/~1api~1v1~1drafts/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33","exampleIds":["paths/~1api~1v1~1drafts/post/responses/200/content/application~1json/example"]}}},{"code":"201","schemaId":"schema_33","exampleIds":["paths/~1api~1v1~1drafts/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33","exampleIds":["paths/~1api~1v1~1drafts/post/responses/201/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"403","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"404","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"409","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"422","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"429","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"503","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/drafts/createdraft"}],"panels":[]}]},"httpPath":"/api/v1/drafts"},{"label":"List approved drafts with their text","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/drafts/listapproveddrafts","routeSlug":"/docs/openapi/drafts/listapproveddrafts","metadata":{"seo":{"title":"List approved drafts with their text","description":"Approved drafts with their full text, ready to send or import. Use this when moving approved emails, notes or briefs into another tool. Newest change first. Each subject and body is exactly what the app's Copy and \"Open in email\" give: a record link in the text is written as its name and address, or its name alone where you may not open it. A draft edited after its approval leaves this list until it is approved again. total is null: this read does not count."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listApprovedDrafts","name":"List approved drafts with their text","isWebhook":false,"pointer":"/paths/~1api~1v1~1drafts~1approved/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List approved drafts with their text","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approved drafts with their full text, ready to send or import. Use this when moving approved emails, notes or briefs into another tool. Newest change first. Each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is exactly what the app's Copy and \"Open in email\" give: a record link in the text is written as its name and address, or its name alone where you may not open it. A draft edited after its approval leaves this list until it is approved again. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is null: this read does not count."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hck_live_..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Scopes are per key: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contracts:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"market:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent:ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_12"},{"name":"limit","in":"query","schemaId":"schema_13"}],"pointer":"/paths/~1api~1v1~1drafts~1approved/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/drafts/approved","servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_12"},{"name":"limit","in":"query","required":false,"schemaId":"schema_13"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404","422","429","503"],"pointer":"/api/v1/drafts/approved","href":"drafts/listapproveddrafts","openApiOperationId":"listApprovedDrafts","summary":"List approved drafts with their text"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Done.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34","exampleIds":["paths/~1api~1v1~1drafts~1approved/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_34","exampleIds":["paths/~1api~1v1~1drafts~1approved/get/responses/200/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_or_malformed_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, or one that is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a valid key sent any other way lands here. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a well-formed key we do not hold, or a revoked one. The message names which."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key lacks the scope this route requires; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insufficient_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No such record. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The query string did not parse; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the issues. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_query"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A ceiling was reached: the per-minute request limit ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the per-key day ceiling of 200 runs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.resets_in_seconds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or the product's own daily model budget ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget_exhausted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fails closed, nothing spent: no database ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"database_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or no usable model provider ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"}],"pointer":"/paths/~1api~1v1~1drafts~1approved/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_34","exampleIds":["paths/~1api~1v1~1drafts~1approved/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34","exampleIds":["paths/~1api~1v1~1drafts~1approved/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"403","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"404","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"422","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"429","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"503","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/drafts/listapproveddrafts"}],"panels":[]}]},"httpPath":"/api/v1/drafts/approved"},{"label":"Read a draft","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/drafts/readdraft","routeSlug":"/docs/openapi/drafts/readdraft","metadata":{"seo":{"title":"Read a draft","description":"One draft with its text, its evidence and whether it is approved. Use this when you have a draft's id and need what it says. sections hold the stored text, record links as written, which is what an edit sends back; body is the text as the app's Copy gives it. approval is null unless this version is approved."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"readDraft","name":"Read a draft","isWebhook":false,"pointer":"/paths/~1api~1v1~1drafts~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Read a draft","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One draft with its text, its evidence and whether it is approved. Use this when you have a draft's id and need what it says. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sections"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hold the stored text, record links as written, which is what an edit sends back; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the text as the app's Copy gives it. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"approval"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is null unless this version is approved."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hck_live_..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Scopes are per key: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contracts:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"market:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent:ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1drafts~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/drafts/{id}","servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404","422","429","503"],"pointer":"/api/v1/drafts/{id}","href":"drafts/readdraft","openApiOperationId":"readDraft","summary":"Read a draft"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Done.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33","exampleIds":["paths/~1api~1v1~1drafts~1{id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_33","exampleIds":["paths/~1api~1v1~1drafts~1{id}/get/responses/200/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_or_malformed_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, or one that is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a valid key sent any other way lands here. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a well-formed key we do not hold, or a revoked one. The message names which."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key lacks the scope this route requires; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insufficient_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No such record. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The query string did not parse; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the issues. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_query"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A ceiling was reached: the per-minute request limit ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the per-key day ceiling of 200 runs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.resets_in_seconds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or the product's own daily model budget ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget_exhausted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fails closed, nothing spent: no database ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"database_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or no usable model provider ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"}],"pointer":"/paths/~1api~1v1~1drafts~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_33","exampleIds":["paths/~1api~1v1~1drafts~1{id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33","exampleIds":["paths/~1api~1v1~1drafts~1{id}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"403","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"404","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"422","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"429","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"503","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/drafts/readdraft"}],"panels":[]}]},"httpPath":"/api/v1/drafts/{id}"},{"label":"Change a draft","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/drafts/editdraft","routeSlug":"/docs/openapi/drafts/editdraft","metadata":{"seo":{"title":"Change a draft","description":"Change a draft's text or fields in one version. Send the version you read; a newer one is a conflict carrying it. Use this when someone asks to edit a saved draft. ops are the draft's own operations, applied as one new version: replace_text, rewrite, add_section, update_section, remove_section, move_section and set_field (title, purpose, audience). expectedRevisionNo is required; a newer version is 409 revision_conflict carrying it. The version is the key holder's own text, recorded with the key and never as written by the assistant, and it is not run through the assistant's drafting checks. A change takes an approved draft back out of review."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"editDraft","name":"Change a draft","isWebhook":false,"pointer":"/paths/~1api~1v1~1drafts~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change a draft","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Change a draft's text or fields in one version. Send the version you read; a newer one is a conflict carrying it. Use this when someone asks to edit a saved draft. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ops"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are the draft's own operations, applied as one new version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"replace_text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rewrite"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"add_section"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"update_section"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"remove_section"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"move_section"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"set_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purpose"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audience"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expectedRevisionNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required; a newer version is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409 revision_conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carrying it. The version is the key holder's own text, recorded with the key and never as written by the assistant, and it is not run through the assistant's drafting checks. A change takes an approved draft back out of review."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hck_live_..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Scopes are per key: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contracts:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"market:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent:ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1drafts~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_16","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 to 128 characters. A retry with the same key and body returns the first result; the same key with another body is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1v1~1drafts~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_35","exampleIds":["paths/~1api~1v1~1drafts~1{id}/patch/requestBody/content/application~1json/example"]}},"schemaId":"schema_35","exampleIds":["paths/~1api~1v1~1drafts~1{id}/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1drafts~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/drafts/{id}","servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_16"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_35","exampleIds":["paths/~1api~1v1~1drafts~1{id}/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","401","403","404","409","422","429","503"],"pointer":"/api/v1/drafts/{id}","href":"drafts/editdraft","openApiOperationId":"editDraft","summary":"Change a draft"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"schemaId":"schema_35","exampleIds":["paths/~1api~1v1~1drafts~1{id}/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_35","exampleIds":["paths/~1api~1v1~1drafts~1{id}/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Done.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33","exampleIds":["paths/~1api~1v1~1drafts~1{id}/patch/responses/200/content/application~1json/example"]}},"schemaId":"schema_33","exampleIds":["paths/~1api~1v1~1drafts~1{id}/patch/responses/200/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_or_malformed_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, or one that is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a valid key sent any other way lands here. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a well-formed key we do not hold, or a revoked one. The message names which."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insufficient_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the key lacks this route's scope; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"owner_only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — only the owner can archive. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — restore it in the app before changing it."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No such record. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idempotency_conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Idempotency-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was used for a different request; send a new key. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revision_conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — someone saved a newer version; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.current.revisionNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"step_changed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — someone changed that step first; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.current.revisionNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names the version that holds it."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the body is not JSON, breaks the schema, or names an unknown field (a tier or an account included). Or the change cannot apply: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.opIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expected_revision_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_organization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_row"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_step"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_assignee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_transition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blocked_reason_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list_full"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A ceiling was reached: the per-minute request limit ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the per-key day ceiling of 200 runs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.resets_in_seconds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or the product's own daily model budget ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget_exhausted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fails closed, nothing spent: no database ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"database_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or no usable model provider ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"}],"pointer":"/paths/~1api~1v1~1drafts~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_33","exampleIds":["paths/~1api~1v1~1drafts~1{id}/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33","exampleIds":["paths/~1api~1v1~1drafts~1{id}/patch/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"403","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"404","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"409","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"422","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"429","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"503","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/drafts/editdraft"}],"panels":[]}]},"httpPath":"/api/v1/drafts/{id}"},{"label":"Archive a draft","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/drafts/archivedraft","routeSlug":"/docs/openapi/drafts/archivedraft","metadata":{"seo":{"title":"Archive a draft","description":"Archive a draft, which is how a draft is deleted. Use this when someone asks to delete or archive a draft. Archiving is how a draft is deleted; it leaves every draft list, and the app can restore it."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"archiveDraft","name":"Archive a draft","isWebhook":false,"pointer":"/paths/~1api~1v1~1drafts~1{id}~1archive/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Archive a draft","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Archive a draft, which is how a draft is deleted. Use this when someone asks to delete or archive a draft. Archiving is how a draft is deleted; it leaves every draft list, and the app can restore it."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hck_live_..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Scopes are per key: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contracts:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"market:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent:ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1drafts~1{id}~1archive/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_16","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 to 128 characters. A retry with the same key and body returns the first result; the same key with another body is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1v1~1drafts~1{id}~1archive/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_22","exampleIds":["paths/~1api~1v1~1drafts~1{id}~1archive/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_22","exampleIds":["paths/~1api~1v1~1drafts~1{id}~1archive/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1drafts~1{id}~1archive/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/drafts/{id}/archive","servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_16"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_22","exampleIds":["paths/~1api~1v1~1drafts~1{id}~1archive/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","401","403","404","409","422","429","503"],"pointer":"/api/v1/drafts/{id}/archive","href":"drafts/archivedraft","openApiOperationId":"archiveDraft","summary":"Archive a draft"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"schemaId":"schema_22","exampleIds":["paths/~1api~1v1~1drafts~1{id}~1archive/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_22","exampleIds":["paths/~1api~1v1~1drafts~1{id}~1archive/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Done.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33","exampleIds":["paths/~1api~1v1~1drafts~1{id}~1archive/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_33","exampleIds":["paths/~1api~1v1~1drafts~1{id}~1archive/post/responses/200/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_or_malformed_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, or one that is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a valid key sent any other way lands here. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a well-formed key we do not hold, or a revoked one. The message names which."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insufficient_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the key lacks this route's scope; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"owner_only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — only the owner can archive. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — restore it in the app before changing it."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No such record. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idempotency_conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Idempotency-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was used for a different request; send a new key. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revision_conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — someone saved a newer version; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.current.revisionNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"step_changed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — someone changed that step first; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.current.revisionNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names the version that holds it."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the body is not JSON, breaks the schema, or names an unknown field (a tier or an account included). Or the change cannot apply: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.opIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expected_revision_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_organization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_row"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_step"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_assignee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_transition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blocked_reason_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list_full"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A ceiling was reached: the per-minute request limit ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the per-key day ceiling of 200 runs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.resets_in_seconds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or the product's own daily model budget ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget_exhausted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fails closed, nothing spent: no database ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"database_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or no usable model provider ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"}],"pointer":"/paths/~1api~1v1~1drafts~1{id}~1archive/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_33","exampleIds":["paths/~1api~1v1~1drafts~1{id}~1archive/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33","exampleIds":["paths/~1api~1v1~1drafts~1{id}~1archive/post/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"403","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"404","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"409","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"422","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"429","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"503","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/drafts/archivedraft"}],"panels":[]}]},"httpPath":"/api/v1/drafts/{id}/archive"}],"content":{"contentType":"group","meta":{"name":"drafts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"drafts","showPageActions":true},{"nodeType":"markdoc","content":"Drafts you or the assistant wrote: list, read, the approved ones with their text, save, edit as your own text, archive."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/drafts","summary":"List your drafts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/drafts/listdrafts","deprecated":false},{"title":"/api/v1/drafts","summary":"Save a draft","prefix":{"name":"post","color":"post"},"badges":[],"link":"/drafts/createdraft","deprecated":false},{"title":"/api/v1/drafts/approved","summary":"List approved drafts with their text","prefix":{"name":"get","color":"get"},"badges":[],"link":"/drafts/listapproveddrafts","deprecated":false},{"title":"/api/v1/drafts/{id}","summary":"Read a draft","prefix":{"name":"get","color":"get"},"badges":[],"link":"/drafts/readdraft","deprecated":false},{"title":"/api/v1/drafts/{id}","summary":"Change a draft","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/drafts/editdraft","deprecated":false},{"title":"/api/v1/drafts/{id}/archive","summary":"Archive a draft","prefix":{"name":"post","color":"post"},"badges":[],"link":"/drafts/archivedraft","deprecated":false}]}]}]}]}},{"type":"group","label":"reviews","link":"/docs/openapi/reviews","routeSlug":"/docs/openapi/reviews","items":[{"label":"Approve a draft or plan version","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/reviews/approvereview","routeSlug":"/docs/openapi/reviews/approvereview","metadata":{"seo":{"title":"Approve a draft or plan version","description":"Approve the version of a draft or plan you read, as the key's owner: a draft needs drafts:approve and a plan needs actions:approve. The approval covers that version's text only and its history reads \"via API key\". Send revisionNo as the version you read; a newer one is 409 revision_conflict carrying it. It never decides a change the assistant proposed: that address answers 403 person_required, whatever the key's scopes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"approveReview","name":"Approve a draft or plan version","isWebhook":false,"pointer":"/paths/~1api~1v1~1reviews~1{artifactId}~1approve/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Approve a draft or plan version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approve the version of a draft or plan you read, as the key's owner: a draft needs "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"drafts:approve"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a plan needs "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"actions:approve"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The approval covers that version's text only and its history reads \"via API key\". Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revisionNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the version you read; a newer one is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409 revision_conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carrying it. It never decides a change the assistant proposed: that address answers "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403 person_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", whatever the key's scopes."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hck_live_..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Scopes are per key: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contracts:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"market:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent:ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"artifactId","in":"path","schemaId":"schema_0","description":"The draft's or plan's id.","required":true}],"pointer":"/paths/~1api~1v1~1reviews~1{artifactId}~1approve/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_16","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 to 128 characters. A retry with the same key and body returns the first result; the same key with another body is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1v1~1reviews~1{artifactId}~1approve/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_36","exampleIds":["paths/~1api~1v1~1reviews~1{artifactId}~1approve/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_36","exampleIds":["paths/~1api~1v1~1reviews~1{artifactId}~1approve/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1reviews~1{artifactId}~1approve/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/reviews/{artifactId}/approve","servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"parameters":{"path":[{"name":"artifactId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"schemaId":"schema_16"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_36","exampleIds":["paths/~1api~1v1~1reviews~1{artifactId}~1approve/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","401","403","404","409","422","429","503"],"pointer":"/api/v1/reviews/{artifactId}/approve","href":"reviews/approvereview","openApiOperationId":"approveReview","summary":"Approve a draft or plan version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"schemaId":"schema_36","exampleIds":["paths/~1api~1v1~1reviews~1{artifactId}~1approve/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_36","exampleIds":["paths/~1api~1v1~1reviews~1{artifactId}~1approve/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Approved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_37","exampleIds":["paths/~1api~1v1~1reviews~1{artifactId}~1approve/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_37","exampleIds":["paths/~1api~1v1~1reviews~1{artifactId}~1approve/post/responses/200/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_or_malformed_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, or one that is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a valid key sent any other way lands here. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a well-formed key we do not hold, or a revoked one. The message names which."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the address is a change the assistant proposed; a person decides it in the app, whatever the key's scopes. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insufficient_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a draft needs "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"drafts:approve"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a plan "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"actions:approve"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names the one missing. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — restore it in the app before approving it."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No such record. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idempotency_conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Idempotency-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was used for a different request; send a new key. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revision_conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — someone saved a newer version; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.current.revisionNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"step_changed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — someone changed that step first; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.current.revisionNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names the version that holds it."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the body is not JSON, breaks the schema, or names an unknown field (a tier or an account included). Or the change cannot apply: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.opIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expected_revision_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_organization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_row"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_step"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_assignee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_transition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blocked_reason_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list_full"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A ceiling was reached: the per-minute request limit ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the per-key day ceiling of 200 runs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.resets_in_seconds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or the product's own daily model budget ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget_exhausted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fails closed, nothing spent: no database ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"database_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or no usable model provider ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"}],"pointer":"/paths/~1api~1v1~1reviews~1{artifactId}~1approve/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_37","exampleIds":["paths/~1api~1v1~1reviews~1{artifactId}~1approve/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_37","exampleIds":["paths/~1api~1v1~1reviews~1{artifactId}~1approve/post/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"403","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"404","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"409","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"422","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"429","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"503","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reviews/approvereview"}],"panels":[]}]},"httpPath":"/api/v1/reviews/{artifactId}/approve"}],"content":{"contentType":"group","meta":{"name":"reviews"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"reviews","showPageActions":true},{"nodeType":"markdoc","content":"Approve a draft or plan version, as the key's owner, with the approval scope for its kind. An assistant's proposal is never decided by key."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/reviews/{artifactId}/approve","summary":"Approve a draft or plan version","prefix":{"name":"post","color":"post"},"badges":[],"link":"/reviews/approvereview","deprecated":false}]}]}]}]}},{"type":"group","label":"conversations","link":"/docs/openapi/conversations","routeSlug":"/docs/openapi/conversations","items":[{"label":"List your conversations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/conversations/listconversations","routeSlug":"/docs/openapi/conversations/listconversations","metadata":{"seo":{"title":"List your conversations","description":"Your conversations with the assistant, newest first, without their turns. Use this when you need a conversation's id, or want to find an earlier answer. Newest activity first, without their turns. Only your own conversations, never a teammate's; a deleted one is not listed. total is null: this read does not count."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listConversations","name":"List your conversations","isWebhook":false,"pointer":"/paths/~1api~1v1~1conversations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List your conversations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your conversations with the assistant, newest first, without their turns. Use this when you need a conversation's id, or want to find an earlier answer. Newest activity first, without their turns. Only your own conversations, never a teammate's; a deleted one is not listed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is null: this read does not count."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hck_live_..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Scopes are per key: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contracts:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"market:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent:ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_12"},{"name":"limit","in":"query","schemaId":"schema_13"}],"pointer":"/paths/~1api~1v1~1conversations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/conversations","servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"parameters":{"path":[],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_12"},{"name":"limit","in":"query","required":false,"schemaId":"schema_13"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404","422","429","503"],"pointer":"/api/v1/conversations","href":"conversations/listconversations","openApiOperationId":"listConversations","summary":"List your conversations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Done.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38","exampleIds":["paths/~1api~1v1~1conversations/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_38","exampleIds":["paths/~1api~1v1~1conversations/get/responses/200/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_or_malformed_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, or one that is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a valid key sent any other way lands here. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a well-formed key we do not hold, or a revoked one. The message names which."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key lacks the scope this route requires; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insufficient_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No such record. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The query string did not parse; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the issues. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_query"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A ceiling was reached: the per-minute request limit ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the per-key day ceiling of 200 runs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.resets_in_seconds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or the product's own daily model budget ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget_exhausted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fails closed, nothing spent: no database ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"database_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or no usable model provider ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"}],"pointer":"/paths/~1api~1v1~1conversations/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_38","exampleIds":["paths/~1api~1v1~1conversations/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38","exampleIds":["paths/~1api~1v1~1conversations/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"403","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"404","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"422","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"429","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"503","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/listconversations"}],"panels":[]}]},"httpPath":"/api/v1/conversations"},{"label":"Read a conversation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/conversations/readconversation","routeSlug":"/docs/openapi/conversations/readconversation","metadata":{"seo":{"title":"Read a conversation","description":"One conversation with its turns: each question, answer, the records it cited and the work it saved. Use this when you need what the assistant already said. turns is a page, oldest first, with total counting every turn; cursor and limit page it. Each answer's citations carry the address you may open, or null; artifacts are what that turn saved that you may open. Another person's conversation, a deleted one and an unknown id are all 404."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"readConversation","name":"Read a conversation","isWebhook":false,"pointer":"/paths/~1api~1v1~1conversations~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Read a conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One conversation with its turns: each question, answer, the records it cited and the work it saved. Use this when you need what the assistant already said. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"turns"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a page, oldest first, with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" counting every turn; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" page it. Each answer's citations carry the address you may open, or null; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"artifacts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are what that turn saved that you may open. Another person's conversation, a deleted one and an unknown id are all "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hck_live_..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Scopes are per key: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contracts:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"market:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent:ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1conversations~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cursor","in":"query","schemaId":"schema_12"},{"name":"limit","in":"query","schemaId":"schema_13"}],"pointer":"/paths/~1api~1v1~1conversations~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/conversations/{id}","servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"cursor","in":"query","required":false,"schemaId":"schema_12"},{"name":"limit","in":"query","required":false,"schemaId":"schema_13"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404","422","429","503"],"pointer":"/api/v1/conversations/{id}","href":"conversations/readconversation","openApiOperationId":"readConversation","summary":"Read a conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Done.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39","exampleIds":["paths/~1api~1v1~1conversations~1{id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_39","exampleIds":["paths/~1api~1v1~1conversations~1{id}/get/responses/200/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_or_malformed_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, or one that is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a valid key sent any other way lands here. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a well-formed key we do not hold, or a revoked one. The message names which."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key lacks the scope this route requires; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insufficient_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No such record. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The query string did not parse; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the issues. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_query"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A ceiling was reached: the per-minute request limit ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the per-key day ceiling of 200 runs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.resets_in_seconds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or the product's own daily model budget ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget_exhausted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fails closed, nothing spent: no database ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"database_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or no usable model provider ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"}],"pointer":"/paths/~1api~1v1~1conversations~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_39","exampleIds":["paths/~1api~1v1~1conversations~1{id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39","exampleIds":["paths/~1api~1v1~1conversations~1{id}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"403","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"404","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"422","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"429","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"503","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/readconversation"}],"panels":[]}]},"httpPath":"/api/v1/conversations/{id}"},{"label":"Rename a conversation","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/conversations/renameconversation","routeSlug":"/docs/openapi/conversations/renameconversation","metadata":{"seo":{"title":"Rename a conversation","description":"Give a conversation a new title, or null to go back to its first question. Use this when someone asks to rename a conversation. The same rename the app makes: at most 80 characters, trimmed; null goes back to the first question. Only your own conversation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"renameConversation","name":"Rename a conversation","isWebhook":false,"pointer":"/paths/~1api~1v1~1conversations~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rename a conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Give a conversation a new title, or null to go back to its first question. Use this when someone asks to rename a conversation. The same rename the app makes: at most 80 characters, trimmed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" goes back to the first question. Only your own conversation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hck_live_..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Scopes are per key: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contracts:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"market:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent:ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1conversations~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_40","exampleIds":["paths/~1api~1v1~1conversations~1{id}/patch/requestBody/content/application~1json/example"]}},"schemaId":"schema_40","exampleIds":["paths/~1api~1v1~1conversations~1{id}/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1conversations~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/v1/conversations/{id}","servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_40","exampleIds":["paths/~1api~1v1~1conversations~1{id}/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","401","403","404","422","429","503"],"pointer":"/api/v1/conversations/{id}","href":"conversations/renameconversation","openApiOperationId":"renameConversation","summary":"Rename a conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"schemaId":"schema_40","exampleIds":["paths/~1api~1v1~1conversations~1{id}/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_40","exampleIds":["paths/~1api~1v1~1conversations~1{id}/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Done.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41","exampleIds":["paths/~1api~1v1~1conversations~1{id}/patch/responses/200/content/application~1json/example"]}},"schemaId":"schema_41","exampleIds":["paths/~1api~1v1~1conversations~1{id}/patch/responses/200/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_or_malformed_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, or one that is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a valid key sent any other way lands here. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a well-formed key we do not hold, or a revoked one. The message names which."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key lacks the scope this route requires; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insufficient_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No such record. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the body is not JSON, breaks the schema, or names an unknown field (a tier or an account included). Or the change cannot apply: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.opIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expected_revision_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_organization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_row"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_step"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_assignee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_transition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blocked_reason_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list_full"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A ceiling was reached: the per-minute request limit ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the per-key day ceiling of 200 runs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.resets_in_seconds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or the product's own daily model budget ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget_exhausted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fails closed, nothing spent: no database ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"database_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or no usable model provider ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"}],"pointer":"/paths/~1api~1v1~1conversations~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_41","exampleIds":["paths/~1api~1v1~1conversations~1{id}/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41","exampleIds":["paths/~1api~1v1~1conversations~1{id}/patch/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"403","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"404","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"422","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"429","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"503","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/renameconversation"}],"panels":[]}]},"httpPath":"/api/v1/conversations/{id}"},{"label":"Delete a conversation","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/conversations/deleteconversation","routeSlug":"/docs/openapi/conversations/deleteconversation","metadata":{"seo":{"title":"Delete a conversation","description":"Delete a conversation, as the app does: it leaves your list and its address stops opening. It answers 204 with no body, and deleting it twice is fine. Use this when someone asks to delete a conversation. The same delete the app makes: an answer still being written in it is stopped first, the conversation leaves your list, and its address answers 404 from then on. The Lists and drafts it saved stay. Deleting it again answers 204 too. Only your own conversation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteConversation","name":"Delete a conversation","isWebhook":false,"pointer":"/paths/~1api~1v1~1conversations~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a conversation, as the app does: it leaves your list and its address stops opening. It answers 204 with no body, and deleting it twice is fine. Use this when someone asks to delete a conversation. The same delete the app makes: an answer still being written in it is stopped first, the conversation leaves your list, and its address answers "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from then on. The Lists and drafts it saved stay. Deleting it again answers "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"204"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" too. Only your own conversation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hck_live_..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Scopes are per key: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contracts:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"market:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent:ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1api~1v1~1conversations~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/conversations/{id}","servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","401","403","404","422","429","503"],"pointer":"/api/v1/conversations/{id}","href":"conversations/deleteconversation","openApiOperationId":"deleteConversation","summary":"Delete a conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deleted, or already deleted. No body."},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_or_malformed_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, or one that is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a valid key sent any other way lands here. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a well-formed key we do not hold, or a revoked one. The message names which."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key lacks the scope this route requires; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insufficient_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No such record. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the body is not JSON, breaks the schema, or names an unknown field (a tier or an account included). Or the change cannot apply: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.opIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expected_revision_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_organization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_row"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_step"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown_assignee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_transition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blocked_reason_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list_full"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A ceiling was reached: the per-minute request limit ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the per-key day ceiling of 200 runs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.resets_in_seconds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or the product's own daily model budget ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget_exhausted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fails closed, nothing spent: no database ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"database_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or no usable model provider ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"}],"pointer":"/paths/~1api~1v1~1conversations~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"403","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"404","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"422","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"429","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"503","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/deleteconversation"}],"panels":[]}]},"httpPath":"/api/v1/conversations/{id}"}],"content":{"contentType":"group","meta":{"name":"conversations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"conversations","showPageActions":true},{"nodeType":"markdoc","content":"Your conversations with the assistant: list, read with every turn, its citations and the work it saved, rename, delete."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/conversations","summary":"List your conversations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/conversations/listconversations","deprecated":false},{"title":"/api/v1/conversations/{id}","summary":"Read a conversation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/conversations/readconversation","deprecated":false},{"title":"/api/v1/conversations/{id}","summary":"Rename a conversation","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/conversations/renameconversation","deprecated":false},{"title":"/api/v1/conversations/{id}","summary":"Delete a conversation","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/conversations/deleteconversation","deprecated":false}]}]}]}]}},{"type":"group","label":"memory","link":"/docs/openapi/memory","routeSlug":"/docs/openapi/memory","items":[{"label":"Read what HRC Ledger knows about your company","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/memory/readmemory","routeSlug":"/docs/openapi/memory/readmemory","metadata":{"seo":{"title":"Read what HRC Ledger knows about your company","description":"What HRC Ledger knows about your company: the confirmed entries, each with where it came from and whether it was said or inferred, at most 200, with the total. Use this when you need the customer's ideal prospects, exclusions or tone. The entries the assistant is given, each in words: basis says whether someone said it or HRC Ledger inferred it, source where it came from, updatedAt when. An entry waiting for a person to confirm it never appears. A company with nothing confirmed yet has no entries. total counts every confirmed entry, so fewer entries than total means the read was cut at 200."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"readMemory","name":"Read what HRC Ledger knows about your company","isWebhook":false,"pointer":"/paths/~1api~1v1~1memory/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Read what HRC Ledger knows about your company","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What HRC Ledger knows about your company: the confirmed entries, each with where it came from and whether it was said or inferred, at most 200, with the total. Use this when you need the customer's ideal prospects, exclusions or tone. The entries the assistant is given, each in words: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"basis"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" says whether someone said it or HRC Ledger inferred it, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where it came from, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when. An entry waiting for a person to confirm it never appears. A company with nothing confirmed yet has no entries. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" counts every confirmed entry, so fewer "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entries"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the read was cut at 200."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hck_live_..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Scopes are per key: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contracts:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"market:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent:ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/memory","servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404","422","429","503"],"pointer":"/api/v1/memory","href":"memory/readmemory","openApiOperationId":"readMemory","summary":"Read what HRC Ledger knows about your company"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Done.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_42","exampleIds":["paths/~1api~1v1~1memory/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_42","exampleIds":["paths/~1api~1v1~1memory/get/responses/200/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_or_malformed_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, or one that is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a valid key sent any other way lands here. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a well-formed key we do not hold, or a revoked one. The message names which."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key lacks the scope this route requires; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insufficient_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No such record. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The query string did not parse; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the issues. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_query"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A ceiling was reached: the per-minute request limit ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the per-key day ceiling of 200 runs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.resets_in_seconds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or the product's own daily model budget ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget_exhausted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fails closed, nothing spent: no database ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"database_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or no usable model provider ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"}],"pointer":"/paths/~1api~1v1~1memory/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_42","exampleIds":["paths/~1api~1v1~1memory/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_42","exampleIds":["paths/~1api~1v1~1memory/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"403","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"404","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"422","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"429","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"503","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/memory/readmemory"}],"panels":[]}]},"httpPath":"/api/v1/memory"}],"content":{"contentType":"group","meta":{"name":"memory"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"memory","showPageActions":true},{"nodeType":"markdoc","content":"What HRC Ledger knows about your firm: the confirmed entries the assistant is given, with where each came from."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/memory","summary":"Read what HRC Ledger knows about your company","prefix":{"name":"get","color":"get"},"badges":[],"link":"/memory/readmemory","deprecated":false}]}]}]}]}},{"type":"separator","label":"The agent","content":null},{"type":"group","label":"agent","link":"/docs/openapi/agent","routeSlug":"/docs/openapi/agent","items":[{"label":"Ask the assistant a question","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/agent/ask","routeSlug":"/docs/openapi/agent/ask","metadata":{"seo":{"title":"Ask the assistant a question","description":"Use this to ask the HRC Ledger assistant one question and get its answer, the records it cites and what it read. Requires the agent:ask scope, which is separate from the read scopes because asking spends money. It does not stream, does not write and does not read the web. A run that stopped at a ceiling is a 200 carrying status: \"partial\" and a stopped_reason — an incomplete answer the caller can tell is incomplete, not an error. Bounded to 200 runs per key per UTC day."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ask","name":"Ask the assistant a question","isWebhook":false,"pointer":"/paths/~1api~1v1~1ask/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ask the assistant a question","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this to ask the HRC Ledger assistant one question and get its answer, the records it cites and what it read. Requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent:ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope, which is separate from the read scopes because asking spends money. It does not stream, does not write and does not read the web. A run that stopped at a ceiling is a 200 carrying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status: \"partial\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stopped_reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — an incomplete answer the caller can tell is incomplete, not an error. Bounded to 200 runs per key per UTC day."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hck_live_..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Scopes are per key: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contracts:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"market:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent:ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AskRequest","exampleIds":["paths/~1api~1v1~1ask/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/AskRequest","exampleIds":["paths/~1api~1v1~1ask/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1v1~1ask/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/ask","servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AskRequest","exampleIds":["paths/~1api~1v1~1ask/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","401","403","409","422","429","503"],"pointer":"/api/v1/ask","href":"agent/ask","openApiOperationId":"ask","summary":"Ask the assistant a question"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi","description":"Mock server","isMockServer":true},{"url":"https://hrcledger.com"}],"schemaId":"components/schemas/AskRequest","exampleIds":["paths/~1api~1v1~1ask/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AskRequest","exampleIds":["paths/~1api~1v1~1ask/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The run's answer. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partial"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_43","exampleIds":["paths/~1api~1v1~1ask/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_43","exampleIds":["paths/~1api~1v1~1ask/post/responses/200/content/application~1json/example"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"missing_or_malformed_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, or one that is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a valid key sent any other way lands here. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — a well-formed key we do not hold, or a revoked one. The message names which."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key lacks the scope this route requires; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insufficient_scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automated model work is paused. The system is healthy and deliberately stopped, and nothing was spent. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paused"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The body failed validation, including an unknown "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skill"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and any unknown field. Code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A ceiling was reached: the per-minute request limit ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), the per-key day ceiling of 200 runs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rate_limited"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.resets_in_seconds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or the product's own daily model budget ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget_exhausted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the seconds."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fails closed, nothing spent: no database ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"database_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or no usable model provider ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model_unavailable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}},"schemaId":"components/schemas/ApiErrorEnvelope"}],"pointer":"/paths/~1api~1v1~1ask/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_43","exampleIds":["paths/~1api~1v1~1ask/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_43","exampleIds":["paths/~1api~1v1~1ask/post/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"403","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"409","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"422","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"429","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}},{"code":"503","schemaId":"components/schemas/ApiErrorEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiErrorEnvelope"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent/ask"}],"panels":[]}]},"httpPath":"/api/v1/ask"}],"content":{"contentType":"group","meta":{"name":"agent"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"agent","showPageActions":true},{"nodeType":"markdoc","content":"Ask the HRC Ledger assistant a question and get its answer, with the records it cites."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/ask","summary":"Ask the assistant a question","prefix":{"name":"post","color":"post"},"badges":[],"link":"/agent/ask","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ApiErrorEnvelope":{"id":"components/schemas/ApiErrorEnvelope","kind":"json-schema","title":"ApiErrorEnvelope","data":{"type":"object","required":["ok","error"],"properties":{"ok":{"const":false},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"scope":{"type":"string"},"limit":{"type":"integer"},"resets_in_seconds":{"type":"integer"},"current":{"type":"object","required":["revisionNo"],"properties":{"revisionNo":{"type":"integer"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revision_conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"step_changed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the version that is current now. Read it, then try again."},"children":[]}]}]}]},"opIndex":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On a refused change: which item of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ops"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" it is about, counted from 0."},"children":[]}]}]}]}}}}}},"components/schemas/PublicContract":{"id":"components/schemas/PublicContract","kind":"json-schema","title":"PublicContract","data":{"type":"object","required":["slug","source","externalId","title","description","buyerName","buyerType","jurisdiction","agency","naics","psc","valueEstimate","postedDate","questionsDueDate","responseDueDate","awardDate","performanceStart","performanceEnd","setAside","url"],"properties":{"slug":{"type":"string"},"source":{"type":"string"},"externalId":{"type":["string","null"]},"title":{"type":"string"},"description":{"type":["string","null"]},"buyerName":{"type":["string","null"]},"buyerType":{"type":["string","null"]},"jurisdiction":{"type":["string","null"]},"agency":{"type":["string","null"]},"naics":{"type":["string","null"]},"psc":{"type":["string","null"]},"valueEstimate":{"type":["number","null"]},"postedDate":{"type":["string","null"],"format":"date"},"questionsDueDate":{"type":["string","null"],"format":"date"},"responseDueDate":{"type":["string","null"],"format":"date"},"awardDate":{"type":["string","null"],"format":"date"},"performanceStart":{"type":["string","null"],"format":"date"},"performanceEnd":{"type":["string","null"],"format":"date"},"setAside":{"type":["string","null"]},"url":{"type":["string","null"]}}}},"components/schemas/PublicOrg":{"id":"components/schemas/PublicOrg","kind":"json-schema","title":"PublicOrg","data":{"type":"object","required":["slug","name","segment","state","locationCount","staffedBeds","ccn","npi","ein"],"properties":{"slug":{"type":"string"},"name":{"type":"string"},"segment":{"type":["string","null"]},"state":{"type":["string","null"]},"locationCount":{"type":["integer","null"]},"staffedBeds":{"type":["integer","null"]},"ccn":{"type":["string","null"]},"npi":{"type":["string","null"]},"ein":{"type":["string","null"]}}}},"components/schemas/AskRequest":{"id":"components/schemas/AskRequest","kind":"json-schema","title":"AskRequest","data":{"type":"object","additionalProperties":false,"required":["question"],"properties":{"question":{"type":"string","minLength":8,"maxLength":20000,"description":"Trimmed before the bounds are applied. The same bounds the web surface enforces."},"contract":{"type":"string","enum":["list","draft","actions","general"],"description":"Optional. The output contract the answer must take. Omitted resolves to general on the server and is never inferred from the question. An unknown value is a 422 naming the four, never a silent fallback."},"skill":{"type":"string","enum":["draft","target_list","audience","answer","general"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated, read for one release and only when contract is omitted: target_list and audience decode as list, answer as general, draft and general as themselves. Send contract instead. An unknown value is a 422."},"children":[]}]}]}]},"prior_run_id":{"type":"string","minLength":1,"maxLength":24,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional. A prior run's public_id, when this question answers that run's clarifying question. Resolved with the caller's own key as viewer, so a public_id belonging to another account is a 404 not_found."},"children":[]}]}]}]},"conversation":{"type":"string","pattern":"^[A-Za-z0-9_-]{20,24}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional. The conversation to append this question to, as returned in data.conversation.id. Omitted opens a new conversation. Resolved against the key's own account, so a conversation belonging to another account is a 404 not_found. The body never carries message content: the prior turns are rebuilt server-side, and a long thread is trimmed by the replay depth cap documented in docs/API.md."},"children":[]}]}]}]},"time_zone":{"type":"string","example":"America/Chicago","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional. The asker's IANA time zone, which dates the run so relative dates such as last week resolve in the asker's calendar. An invalid value is never a 422: it is read as unknown, and the run assumes US Eastern (America/New_York) and says so. A zone saved on the key's account outranks this field, which is then only a fallback."},"children":[]}]}]}]}}}},"components/schemas/AskData":{"id":"components/schemas/AskData","kind":"json-schema","title":"AskData","data":{"type":"object","required":["run","conversation","answer","citations","rows","coverage","usage","feedback"],"properties":{"run":{"type":"object","required":["id","url","status","contract","stopped_reason","partial_note"],"properties":{"id":{"type":"string"},"url":{"type":"string","description":"Absolute. The same run, openable by a person."},"status":{"type":"string","enum":["complete","partial","failed"]},"contract":{"type":"string","enum":["list","draft","actions","general"],"description":"The output contract that was in force, resolved on the server."},"stopped_reason":{"type":["string","null"],"enum":[null,"step_ceiling","cost_ceiling","wall_clock","budget","paused","error","unsupported_citation","unsupported_outcome","output_cap","call_timeout","no_answer","no_progress","stopped_by_person","disconnected"]},"partial_note":{"type":["string","null"],"description":"The sentence a partial run carries. Null on a complete run."}}},"conversation":{"type":"object","required":["id","url","turn"],"properties":{"id":{"type":"string","description":"Send this back as the request's conversation to ask a follow-up in the same thread."},"url":{"type":"string","description":"Absolute. The same thread, readable by a person."},"turn":{"type":"integer","description":"This run's ordinal in the thread. A new conversation opens at 1."}}},"answer":{"type":["string","null"]},"citations":{"type":"array","items":{"type":"object","required":["claim","record","url","absence"],"properties":{"claim":{"type":["string","null"],"description":"The sentence the record supports, derived from the answer text."},"record":{"type":"object","required":["type","key"],"properties":{"type":{"type":"string","enum":["contract","organization","person","document"]},"key":{"type":"string"}}},"url":{"type":["string","null"]},"absence":{"type":["string","null"],"enum":[null,"not_checked","not_held","unreadable","not_published","none_found"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Why "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is null: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_held"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means we looked and hold no such record; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_checked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means this handle has no public lookup. Null when the record resolved."},"children":[]}]}]}]}}}},"rows":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rows this run recorded, in order. Empty means the ledger holds no rows for the run, never that no records were read — what a run read is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"coverage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"object","required":["type","key","row"],"properties":{"type":{"type":"string"},"key":{"type":"string"},"row":{"type":"object"}}}},"coverage":{"type":"object","required":["views","steps","note","unreadable"],"properties":{"views":{"type":"array","items":{"type":"object","required":["view","rows_returned"],"properties":{"view":{"type":"string"},"rows_returned":{"type":["integer","null"]}}}},"steps":{"type":"integer"},"note":{"type":"string","description":"Emitted by code, not by the model."},"unreadable":{"type":"integer","description":"Reads that failed or were refused. Non-zero means the answer is built on less."}}},"usage":{"type":"object","required":["cost_cents","input_tokens","output_tokens","cached_tokens"],"properties":{"cost_cents":{"type":["integer","null"],"description":"Null is not yet known or under a cent. Never 0 for work that was billed."},"input_tokens":{"type":["integer","null"]},"output_tokens":{"type":["integer","null"]},"cached_tokens":{"type":["integer","null"],"description":"Null means the provider said nothing about the cache, which is not a reported zero."}}},"feedback":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Where to send the two feedback controls for this run (036-FR-020). The same signal the web transcript and the Slack reply carry; a machine presses it by POSTing to url. It carries no signal of its own — nothing has been pressed when this response is composed."},"children":[]}]}]}],"required":["url","run","controls"],"properties":{"url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relative path. POST { run, rating?, used? }; a body stating neither rating nor used is refused, and an unknown field (including a shape) is refused rather than stripped."},"children":[]}]}]}]},"run":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The run a press is recorded against — the same token as run.id."},"children":[]}]}]}]},"controls":{"type":"array","description":"The two independent signals a press may state. Useful and acted-on are two facts, not one.","items":{"type":"string"}}}}}}},"components/schemas/PublicList":{"id":"components/schemas/PublicList","kind":"json-schema","title":"PublicList","data":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"name":{"type":"string"},"purpose":{"type":"string"},"archived":{"type":"boolean"},"revisionNo":{"type":"integer"},"updatedAt":{"type":"string"}},"required":["id","url","name","purpose","archived","revisionNo","updatedAt"]}},"components/schemas/PublicListRow":{"id":"components/schemas/PublicListRow","kind":"json-schema","title":"PublicListRow","data":{"type":"object","properties":{"rowId":{"type":"integer"},"kind":{"type":"string"},"key":{"type":"string"},"name":{"type":"string"},"organizationId":{"type":["integer","null"]},"url":{"type":["string","null"]},"note":{"type":["string","null"]},"priority":{"type":["integer","null"]},"addedVia":{"type":["string","null"]},"addedAt":{"type":["string","null"]}},"required":["rowId","kind","key","name","organizationId","url","note","priority","addedVia","addedAt"]}},"components/schemas/PlanStep":{"id":"components/schemas/PlanStep","kind":"json-schema","title":"PlanStep","data":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"status":{"type":"string","enum":["todo","in_progress","blocked","done","cancelled"]},"assignee":{"type":["object","null"],"properties":{"userId":{"type":["integer","null"]},"label":{"type":["string","null"]}},"required":["userId","label"],"additionalProperties":false},"dueDate":{"type":["string","null"]},"blockedReason":{"type":["string","null"]}},"required":["id","title","status","assignee","dueDate","blockedReason"]}},"components/schemas/PublicPlan":{"id":"components/schemas/PublicPlan","kind":"json-schema","title":"PublicPlan","data":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"title":{"type":"string"},"objective":{"type":"string"},"archived":{"type":"boolean"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/PlanStep"}},"revisionNo":{"type":"integer"},"updatedAt":{"type":"string"}},"required":["id","url","title","objective","archived","steps","revisionNo","updatedAt"]}},"components/schemas/PublicPlanSummary":{"id":"components/schemas/PublicPlanSummary","kind":"json-schema","title":"PublicPlanSummary","data":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"title":{"type":"string"},"objective":{"type":"string"},"archived":{"type":"boolean"},"revisionNo":{"type":"integer"},"updatedAt":{"type":"string"}},"required":["id","url","title","objective","archived","revisionNo","updatedAt"]}},"components/schemas/PublicStepRow":{"id":"components/schemas/PublicStepRow","kind":"json-schema","title":"PublicStepRow","data":{"type":"object","properties":{"planId":{"type":"string"},"planTitle":{"type":"string"},"planUrl":{"type":"string"},"stepId":{"type":"string"},"title":{"type":"string"},"status":{"type":"string","enum":["todo","in_progress","blocked","done","cancelled"]},"assigneeUserId":{"type":["integer","null"]},"dueDate":{"type":["string","null"]},"revisionNo":{"type":"integer"}},"required":["planId","planTitle","planUrl","stepId","title","status","assigneeUserId","dueDate","revisionNo"]}},"components/schemas/DraftSection":{"id":"components/schemas/DraftSection","kind":"json-schema","title":"DraftSection","data":{"type":"object","properties":{"id":{"type":"string"},"heading":{"type":["string","null"]},"text":{"type":"string"}},"required":["id","heading","text"]}},"components/schemas/RecordReference":{"id":"components/schemas/RecordReference","kind":"json-schema","title":"RecordReference","data":{"type":"object","properties":{"type":{"type":"string"},"key":{"type":"string"},"url":{"type":["string","null"],"description":"The address you may open, or null where you may not."}},"required":["type","key","url"]}},"components/schemas/PublicDraft":{"id":"components/schemas/PublicDraft","kind":"json-schema","title":"PublicDraft","data":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"title":{"type":"string"},"purpose":{"type":"string"},"audience":{"type":["string","null"]},"sections":{"type":"array","items":{"$ref":"#/components/schemas/DraftSection"}},"subject":{"type":"string","description":"The draft's title, as the app's \"Open in email\" uses it."},"body":{"type":"string","description":"The sections as plain text, exactly what the app's Copy gives."},"evidence":{"type":"array","items":{"$ref":"#/components/schemas/RecordReference"}},"approval":{"type":["object","null"],"properties":{"revisionNo":{"type":"integer"},"at":{"type":"string"}},"required":["revisionNo","at"],"additionalProperties":false},"archived":{"type":"boolean"},"revisionNo":{"type":"integer"},"updatedAt":{"type":"string"}},"required":["id","url","title","purpose","audience","sections","subject","body","evidence","approval","archived","revisionNo","updatedAt"]}},"components/schemas/PublicDraftSummary":{"id":"components/schemas/PublicDraftSummary","kind":"json-schema","title":"PublicDraftSummary","data":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"title":{"type":"string"},"purpose":{"type":"string"},"audience":{"type":["string","null"]},"evidence":{"type":"array","items":{"$ref":"#/components/schemas/RecordReference"}},"approval":{"type":["object","null"],"properties":{"revisionNo":{"type":"integer"},"at":{"type":"string"}},"required":["revisionNo","at"],"additionalProperties":false},"archived":{"type":"boolean"},"revisionNo":{"type":"integer"},"updatedAt":{"type":"string"}},"required":["id","url","title","purpose","audience","evidence","approval","archived","revisionNo","updatedAt"]}},"components/schemas/PublicConversationSummary":{"id":"components/schemas/PublicConversationSummary","kind":"json-schema","title":"PublicConversationSummary","data":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"title":{"type":"string"},"turnCount":{"type":"integer"},"awaitingAnswer":{"type":"boolean","description":"True when the assistant's last turn asked you a question."},"updatedAt":{"type":"string"}},"required":["id","url","title","turnCount","awaitingAnswer","updatedAt"]}},"components/schemas/ConversationTurn":{"id":"components/schemas/ConversationTurn","kind":"json-schema","title":"ConversationTurn","data":{"type":"object","properties":{"turn":{"type":"integer"},"runId":{"type":"string"},"status":{"type":"string"},"question":{"type":"string"},"answer":{"type":["string","null"]},"citations":{"type":"array","items":{"$ref":"#/components/schemas/RecordReference"}},"artifacts":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"id":{"type":"string"},"url":{"type":"string"}},"required":["kind","id","url"],"additionalProperties":false}},"createdAt":{"type":"string"}},"required":["turn","runId","status","question","answer","citations","artifacts","createdAt"]}},"components/schemas/PublicConversation":{"id":"components/schemas/PublicConversation","kind":"json-schema","title":"PublicConversation","data":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"title":{"type":["string","null"]},"turns":{"type":"object","required":["items","nextCursor","total"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ConversationTurn"}},"nextCursor":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the next page; null on the last."},"children":[]}]}]}]},"total":{"type":["integer","null"],"description":"Every match, counted; null where the read does not count."}}},"createdAt":{"type":["string","null"]},"updatedAt":{"type":["string","null"]}},"required":["id","url","title","turns","createdAt","updatedAt"]}},"components/schemas/PublicMemoryEntry":{"id":"components/schemas/PublicMemoryEntry","kind":"json-schema","title":"PublicMemoryEntry","data":{"type":"object","properties":{"id":{"type":["string","null"]},"kind":{"type":"string"},"about":{"type":"string"},"basis":{"type":"string","enum":["stated","inferred"]},"says":{"type":["string","null"]},"source":{"type":"object","properties":{"kind":{"type":"string"},"label":{"type":["string","null"]}},"required":["kind","label"],"additionalProperties":false},"updatedAt":{"type":"string"}},"required":["id","kind","about","basis","says","source","updatedAt"]}},"components/schemas/PublicApproval":{"id":"components/schemas/PublicApproval","kind":"json-schema","title":"PublicApproval","data":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","enum":["draft","actions"]},"url":{"type":"string"},"revisionNo":{"type":"integer"}},"required":["id","kind","url","revisionNo"]}},"schema_0":{"kind":"json-schema","data":{"type":"string"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"string","enum":["open","closing_soon","closed"]},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"number"},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"string","format":"date"},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"string","enum":["relevance","fit","recent","deadline","value_desc","value_asc"]},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"type":"object","required":["ok","data"],"properties":{"ok":{"const":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/PublicContract"}},"page":{"type":"integer"},"total":{"type":"integer"}}},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"object","required":["ok","data"],"properties":{"ok":{"const":true},"data":{"$ref":"#/components/schemas/PublicContract"}}},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"type":"string","enum":["beds_desc","locations_desc","name"]},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"type":"object","required":["ok","data"],"properties":{"ok":{"const":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/PublicOrg"}},"page":{"type":"integer"},"total":{"type":"integer"},"absence":{"type":"object","description":"Set when an empty answer is our gap, not a finding of none (the ACO filter while no ACO participation is held).","properties":{"reason":{"const":"not_held"},"note":{"type":"string"}}}}},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"type":"string","minLength":1,"maxLength":500},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"default":25,"type":"integer","minimum":1,"maximum":100},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"type":"string","enum":["general","targets","audience"]},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"type":"object","required":["ok","data"],"properties":{"ok":{"const":true},"data":{"type":"object","required":["items","nextCursor","total"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PublicList"}},"nextCursor":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the next page; null on the last."},"children":[]}]}]}]},"total":{"type":["integer","null"],"description":"Every match, counted; null where the read does not count."}}}}},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"type":"string","minLength":1,"maxLength":128},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"purpose":{"default":"general","type":"string","enum":["general","targets","audience"]},"rows":{"minItems":1,"maxItems":10000,"type":"array","items":{"type":"integer","exclusiveMinimum":0}}},"required":["name"],"additionalProperties":false},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"type":"object","required":["ok","data"],"properties":{"ok":{"const":true},"data":{"$ref":"#/components/schemas/PublicList"}}},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"type":"object","required":["ok","data"],"properties":{"ok":{"const":true},"data":{"type":"object","required":["list","rows"],"properties":{"list":{"$ref":"#/components/schemas/PublicList"},"rows":{"type":"object","required":["items","nextCursor","total"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PublicListRow"}},"nextCursor":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the next page; null on the last."},"children":[]}]}]}]},"total":{"type":["integer","null"],"description":"Every match, counted; null where the read does not count."}}}}}}},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200}},"required":["name"],"additionalProperties":false},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"type":"object","properties":{"add":{"minItems":1,"maxItems":10000,"type":"array","items":{"type":"integer","exclusiveMinimum":0}},"remove":{"minItems":1,"maxItems":10000,"type":"array","items":{"type":"integer","exclusiveMinimum":0}}},"required":[],"additionalProperties":false},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"type":"object","properties":{},"required":[],"additionalProperties":false},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["todo","in_progress","blocked","done","cancelled"]}},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"default":"me","type":"string","enum":["me","any"]},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"type":"object","required":["ok","data"],"properties":{"ok":{"const":true},"data":{"type":"object","required":["items","nextCursor","total"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PublicStepRow"}},"nextCursor":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the next page; null on the last."},"children":[]}]}]}]},"total":{"type":["integer","null"],"description":"Every match, counted; null where the read does not count."}}}}},"id":"schema_25"},"schema_26":{"kind":"json-schema","data":{"type":"object","required":["ok","data"],"properties":{"ok":{"const":true},"data":{"type":"object","required":["items","nextCursor","total"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PublicPlanSummary"}},"nextCursor":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the next page; null on the last."},"children":[]}]}]}]},"total":{"type":["integer","null"],"description":"Every match, counted; null where the read does not count."}}}}},"id":"schema_26"},"schema_27":{"kind":"json-schema","data":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":200},"objective":{"type":"string","minLength":1,"maxLength":2000},"purpose":{"default":"general","type":"string","enum":["general","pursuit"]},"steps":{"default":[],"maxItems":100,"type":"array","items":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":200},"dueDate":{"type":"string","format":"date"},"assigneeUserId":{"type":"integer","exclusiveMinimum":0}},"required":["title"],"additionalProperties":false}}},"required":["title","objective"],"additionalProperties":false},"id":"schema_27"},"schema_28":{"kind":"json-schema","data":{"type":"object","required":["ok","data"],"properties":{"ok":{"const":true},"data":{"$ref":"#/components/schemas/PublicPlan"}}},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"type":"object","properties":{"ops":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","additionalProperties":{}}},"expectedRevisionNo":{"type":"integer","exclusiveMinimum":0}},"required":["ops","expectedRevisionNo"],"additionalProperties":false},"id":"schema_29"},"schema_30":{"kind":"json-schema","data":{"type":"object","properties":{"status":{"type":"string","enum":["todo","in_progress","blocked","done","cancelled"]},"blockedReason":{"type":"string","minLength":1,"maxLength":500}},"required":["status"],"additionalProperties":false},"id":"schema_30"},"schema_31":{"kind":"json-schema","data":{"type":"object","required":["ok","data"],"properties":{"ok":{"const":true},"data":{"type":"object","required":["items","nextCursor","total"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PublicDraftSummary"}},"nextCursor":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the next page; null on the last."},"children":[]}]}]}]},"total":{"type":["integer","null"],"description":"Every match, counted; null where the read does not count."}}}}},"id":"schema_31"},"schema_32":{"kind":"json-schema","data":{"type":"object","properties":{"subject":{"type":"string","minLength":1,"maxLength":200},"purpose":{"type":"string","enum":["email","ad","note","call_opener","brief","assessment","proposal","thesis","general"]},"audience":{"type":"string","minLength":1,"maxLength":300},"body":{"type":"string","minLength":1,"maxLength":20000}},"required":["subject","purpose","body"],"additionalProperties":false},"id":"schema_32"},"schema_33":{"kind":"json-schema","data":{"type":"object","required":["ok","data"],"properties":{"ok":{"const":true},"data":{"$ref":"#/components/schemas/PublicDraft"}}},"id":"schema_33"},"schema_34":{"kind":"json-schema","data":{"type":"object","required":["ok","data"],"properties":{"ok":{"const":true},"data":{"type":"object","required":["items","nextCursor","total"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PublicDraft"}},"nextCursor":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the next page; null on the last."},"children":[]}]}]}]},"total":{"type":["integer","null"],"description":"Every match, counted; null where the read does not count."}}}}},"id":"schema_34"},"schema_35":{"kind":"json-schema","data":{"type":"object","properties":{"ops":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"expectedRevisionNo":{"type":"integer","exclusiveMinimum":0}},"required":["ops","expectedRevisionNo"],"additionalProperties":false},"id":"schema_35"},"schema_36":{"kind":"json-schema","data":{"type":"object","properties":{"revisionNo":{"type":"integer","minimum":1}},"required":["revisionNo"],"additionalProperties":false},"id":"schema_36"},"schema_37":{"kind":"json-schema","data":{"type":"object","required":["ok","data"],"properties":{"ok":{"const":true},"data":{"$ref":"#/components/schemas/PublicApproval"}}},"id":"schema_37"},"schema_38":{"kind":"json-schema","data":{"type":"object","required":["ok","data"],"properties":{"ok":{"const":true},"data":{"type":"object","required":["items","nextCursor","total"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PublicConversationSummary"}},"nextCursor":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the next page; null on the last."},"children":[]}]}]}]},"total":{"type":["integer","null"],"description":"Every match, counted; null where the read does not count."}}}}},"id":"schema_38"},"schema_39":{"kind":"json-schema","data":{"type":"object","required":["ok","data"],"properties":{"ok":{"const":true},"data":{"$ref":"#/components/schemas/PublicConversation"}}},"id":"schema_39"},"schema_40":{"kind":"json-schema","data":{"type":"object","properties":{"title":{"anyOf":[{"type":"string","minLength":1,"maxLength":80},{"type":"null"}]}},"required":["title"],"additionalProperties":false},"id":"schema_40"},"schema_41":{"kind":"json-schema","data":{"type":"object","required":["ok","data"],"properties":{"ok":{"const":true},"data":{"$ref":"#/components/schemas/PublicConversationSummary"}}},"id":"schema_41"},"schema_42":{"kind":"json-schema","data":{"type":"object","required":["ok","data"],"properties":{"ok":{"const":true},"data":{"type":"object","required":["entries","total"],"properties":{"entries":{"type":"array","items":{"$ref":"#/components/schemas/PublicMemoryEntry"}},"total":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every confirmed entry, counted; more than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entries"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" holds when the read was cut."},"children":[]}]}]}]}}}}},"id":"schema_42"},"schema_43":{"kind":"json-schema","data":{"type":"object","required":["ok","data"],"properties":{"ok":{"const":true},"data":{"$ref":"#/components/schemas/AskData"}}},"id":"schema_43"}},"exampleStore":{"paths/~1api~1v1~1contracts/get/responses/200/content/application~1json/example":{"value":{"ok":true,"data":[{"slug":"oh-mercy-ehr-2026","source":"sam","externalId":"36C25026Q0001","title":"Electronic health record replacement","description":"Replace the inpatient EHR across three campuses.","buyerName":"Mercy Health","buyerType":"health_system","jurisdiction":"OH","agency":"Department of Veterans Affairs","naics":"541512","psc":"DA01","valueEstimate":4500000,"postedDate":"2026-09-01","questionsDueDate":"2026-09-20","responseDueDate":"2026-10-30","awardDate":"2026-12-15","performanceStart":"2027-01-01","performanceEnd":"2029-12-31","setAside":"SBA","url":"https://sam.gov/opp/36C25026Q0001/view"}],"page":1,"total":1},"id":"paths/~1api~1v1~1contracts/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1contracts~1{slug}/get/responses/200/content/application~1json/example":{"value":{"ok":true,"data":{"slug":"oh-mercy-ehr-2026","source":"sam","externalId":"36C25026Q0001","title":"Electronic health record replacement","description":"Replace the inpatient EHR across three campuses.","buyerName":"Mercy Health","buyerType":"health_system","jurisdiction":"OH","agency":"Department of Veterans Affairs","naics":"541512","psc":"DA01","valueEstimate":4500000,"postedDate":"2026-09-01","questionsDueDate":"2026-09-20","responseDueDate":"2026-10-30","awardDate":"2026-12-15","performanceStart":"2027-01-01","performanceEnd":"2029-12-31","setAside":"SBA","url":"https://sam.gov/opp/36C25026Q0001/view"}},"id":"paths/~1api~1v1~1contracts~1{slug}/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1market~1orgs/get/responses/200/content/application~1json/example":{"value":{"ok":true,"data":[{"slug":"mercy-health","name":"Mercy Health","segment":"health_system","state":"OH","locationCount":12,"staffedBeds":3400,"ccn":"360001","npi":"1234567893","ein":"341234567"}],"page":1,"total":1},"id":"paths/~1api~1v1~1market~1orgs/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1lists/get/responses/200/content/application~1json/example":{"value":{"ok":true,"data":{"items":[{"id":"Lst8kQ2mZp4xV7nR1tYw","url":"https://hrcledger.com/lists/items/Lst8kQ2mZp4xV7nR1tYw","name":"Virginia systems","purpose":"general","archived":false,"revisionNo":2,"updatedAt":"2026-10-16T14:02:11.000Z"}],"nextCursor":null,"total":null}},"id":"paths/~1api~1v1~1lists/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1lists/post/requestBody/content/application~1json/example":{"value":{"name":"Virginia systems","purpose":"targets","rows":[41,57]},"id":"paths/~1api~1v1~1lists/post/requestBody/content/application~1json/example"},"paths/~1api~1v1~1lists/post/responses/200/content/application~1json/example":{"value":{"ok":true,"data":{"id":"Lst8kQ2mZp4xV7nR1tYw","url":"https://hrcledger.com/lists/items/Lst8kQ2mZp4xV7nR1tYw","name":"Virginia systems","purpose":"general","archived":false,"revisionNo":2,"updatedAt":"2026-10-16T14:02:11.000Z"}},"id":"paths/~1api~1v1~1lists/post/responses/200/content/application~1json/example"},"paths/~1api~1v1~1lists/post/responses/201/content/application~1json/example":{"value":{"ok":true,"data":{"id":"Lst8kQ2mZp4xV7nR1tYw","url":"https://hrcledger.com/lists/items/Lst8kQ2mZp4xV7nR1tYw","name":"Virginia systems","purpose":"general","archived":false,"revisionNo":2,"updatedAt":"2026-10-16T14:02:11.000Z"}},"id":"paths/~1api~1v1~1lists/post/responses/201/content/application~1json/example"},"paths/~1api~1v1~1lists~1{id}/get/responses/200/content/application~1json/example":{"value":{"ok":true,"data":{"list":{"id":"Lst8kQ2mZp4xV7nR1tYw","url":"https://hrcledger.com/lists/items/Lst8kQ2mZp4xV7nR1tYw","name":"Virginia systems","purpose":"general","archived":false,"revisionNo":2,"updatedAt":"2026-10-16T14:02:11.000Z"},"rows":{"items":[{"rowId":4101,"kind":"organization","key":"41","name":"Inova Health System","organizationId":41,"url":"https://hrcledger.com/organizations/inova-health-system","note":"Expanding cardiology","priority":2,"addedVia":"api_key","addedAt":"2026-10-16T14:02:11.000Z"}],"nextCursor":null,"total":1}}},"id":"paths/~1api~1v1~1lists~1{id}/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1lists~1{id}/patch/requestBody/content/application~1json/example":{"value":{"name":"Virginia health systems"},"id":"paths/~1api~1v1~1lists~1{id}/patch/requestBody/content/application~1json/example"},"paths/~1api~1v1~1lists~1{id}/patch/responses/200/content/application~1json/example":{"value":{"ok":true,"data":{"id":"Lst8kQ2mZp4xV7nR1tYw","url":"https://hrcledger.com/lists/items/Lst8kQ2mZp4xV7nR1tYw","name":"Virginia systems","purpose":"general","archived":false,"revisionNo":2,"updatedAt":"2026-10-16T14:02:11.000Z"}},"id":"paths/~1api~1v1~1lists~1{id}/patch/responses/200/content/application~1json/example"},"paths/~1api~1v1~1lists~1{id}~1rows/post/requestBody/content/application~1json/example":{"value":{"add":[41,57],"remove":[12]},"id":"paths/~1api~1v1~1lists~1{id}~1rows/post/requestBody/content/application~1json/example"},"paths/~1api~1v1~1lists~1{id}~1rows/post/responses/200/content/application~1json/example":{"value":{"ok":true,"data":{"id":"Lst8kQ2mZp4xV7nR1tYw","url":"https://hrcledger.com/lists/items/Lst8kQ2mZp4xV7nR1tYw","name":"Virginia systems","purpose":"general","archived":false,"revisionNo":2,"updatedAt":"2026-10-16T14:02:11.000Z"}},"id":"paths/~1api~1v1~1lists~1{id}~1rows/post/responses/200/content/application~1json/example"},"paths/~1api~1v1~1lists~1{id}~1archive/post/requestBody/content/application~1json/example":{"value":{},"id":"paths/~1api~1v1~1lists~1{id}~1archive/post/requestBody/content/application~1json/example"},"paths/~1api~1v1~1lists~1{id}~1archive/post/responses/200/content/application~1json/example":{"value":{"ok":true,"data":{"id":"Lst8kQ2mZp4xV7nR1tYw","url":"https://hrcledger.com/lists/items/Lst8kQ2mZp4xV7nR1tYw","name":"Virginia systems","purpose":"general","archived":true,"revisionNo":2,"updatedAt":"2026-10-16T14:02:11.000Z"}},"id":"paths/~1api~1v1~1lists~1{id}~1archive/post/responses/200/content/application~1json/example"},"paths/~1api~1v1~1lists~1{id}~1export.csv/get/responses/200/content/text~1csv/example":{"value":"Name,Note,Priority,Why now,Fits\r\nInova Health System,Expanding cardiology,2,,\r\n","id":"paths/~1api~1v1~1lists~1{id}~1export.csv/get/responses/200/content/text~1csv/example"},"paths/~1api~1v1~1actions~1steps/get/responses/200/content/application~1json/example":{"value":{"ok":true,"data":{"items":[{"planId":"Pln5tH8jKw2qR6mX9vBz","planTitle":"Win Inova","planUrl":"https://hrcledger.com/actions/items/Pln5tH8jKw2qR6mX9vBz","stepId":"t_Ab3dE5fG","title":"Call the CFO","status":"in_progress","assigneeUserId":7,"dueDate":"2026-10-21","revisionNo":3}],"nextCursor":null,"total":1}},"id":"paths/~1api~1v1~1actions~1steps/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1actions~1plans/get/responses/200/content/application~1json/example":{"value":{"ok":true,"data":{"items":[{"id":"Pln5tH8jKw2qR6mX9vBz","url":"https://hrcledger.com/actions/items/Pln5tH8jKw2qR6mX9vBz","title":"Win Inova","objective":"Win the Inova imaging contract","archived":false,"revisionNo":3,"updatedAt":"2026-10-16T14:02:11.000Z"}],"nextCursor":null,"total":null}},"id":"paths/~1api~1v1~1actions~1plans/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1actions~1plans/post/requestBody/content/application~1json/example":{"value":{"title":"Win Inova","objective":"Win the Inova imaging contract","purpose":"pursuit","steps":[{"title":"Call the CFO","dueDate":"2026-10-21","assigneeUserId":7},{"title":"Send the security review"}]},"id":"paths/~1api~1v1~1actions~1plans/post/requestBody/content/application~1json/example"},"paths/~1api~1v1~1actions~1plans/post/responses/200/content/application~1json/example":{"value":{"ok":true,"data":{"id":"Pln5tH8jKw2qR6mX9vBz","url":"https://hrcledger.com/actions/items/Pln5tH8jKw2qR6mX9vBz","title":"Win Inova","objective":"Win the Inova imaging contract","archived":false,"steps":[{"id":"t_Ab3dE5fG","title":"Call the CFO","status":"in_progress","assignee":{"userId":7,"label":null},"dueDate":"2026-10-21","blockedReason":null},{"id":"t_Hj7kL9mN","title":"Send the security review","status":"blocked","assignee":{"userId":null,"label":"Dana at Inova"},"dueDate":null,"blockedReason":"Waiting on their legal team"}],"revisionNo":3,"updatedAt":"2026-10-16T14:02:11.000Z"}},"id":"paths/~1api~1v1~1actions~1plans/post/responses/200/content/application~1json/example"},"paths/~1api~1v1~1actions~1plans/post/responses/201/content/application~1json/example":{"value":{"ok":true,"data":{"id":"Pln5tH8jKw2qR6mX9vBz","url":"https://hrcledger.com/actions/items/Pln5tH8jKw2qR6mX9vBz","title":"Win Inova","objective":"Win the Inova imaging contract","archived":false,"steps":[{"id":"t_Ab3dE5fG","title":"Call the CFO","status":"in_progress","assignee":{"userId":7,"label":null},"dueDate":"2026-10-21","blockedReason":null},{"id":"t_Hj7kL9mN","title":"Send the security review","status":"blocked","assignee":{"userId":null,"label":"Dana at Inova"},"dueDate":null,"blockedReason":"Waiting on their legal team"}],"revisionNo":3,"updatedAt":"2026-10-16T14:02:11.000Z"}},"id":"paths/~1api~1v1~1actions~1plans/post/responses/201/content/application~1json/example"},"paths/~1api~1v1~1actions~1plans~1{id}/get/responses/200/content/application~1json/example":{"value":{"ok":true,"data":{"id":"Pln5tH8jKw2qR6mX9vBz","url":"https://hrcledger.com/actions/items/Pln5tH8jKw2qR6mX9vBz","title":"Win Inova","objective":"Win the Inova imaging contract","archived":false,"steps":[{"id":"t_Ab3dE5fG","title":"Call the CFO","status":"in_progress","assignee":{"userId":7,"label":null},"dueDate":"2026-10-21","blockedReason":null},{"id":"t_Hj7kL9mN","title":"Send the security review","status":"blocked","assignee":{"userId":null,"label":"Dana at Inova"},"dueDate":null,"blockedReason":"Waiting on their legal team"}],"revisionNo":3,"updatedAt":"2026-10-16T14:02:11.000Z"}},"id":"paths/~1api~1v1~1actions~1plans~1{id}/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1actions~1plans~1{id}/patch/requestBody/content/application~1json/example":{"value":{"expectedRevisionNo":3,"ops":[{"op":"update_step","stepId":"t_Ab3dE5fG","dueDate":"2026-10-23"}]},"id":"paths/~1api~1v1~1actions~1plans~1{id}/patch/requestBody/content/application~1json/example"},"paths/~1api~1v1~1actions~1plans~1{id}/patch/responses/200/content/application~1json/example":{"value":{"ok":true,"data":{"id":"Pln5tH8jKw2qR6mX9vBz","url":"https://hrcledger.com/actions/items/Pln5tH8jKw2qR6mX9vBz","title":"Win Inova","objective":"Win the Inova imaging contract","archived":false,"steps":[{"id":"t_Ab3dE5fG","title":"Call the CFO","status":"in_progress","assignee":{"userId":7,"label":null},"dueDate":"2026-10-21","blockedReason":null},{"id":"t_Hj7kL9mN","title":"Send the security review","status":"blocked","assignee":{"userId":null,"label":"Dana at Inova"},"dueDate":null,"blockedReason":"Waiting on their legal team"}],"revisionNo":3,"updatedAt":"2026-10-16T14:02:11.000Z"}},"id":"paths/~1api~1v1~1actions~1plans~1{id}/patch/responses/200/content/application~1json/example"},"paths/~1api~1v1~1actions~1plans~1{id}~1steps~1{stepId}~1status/post/requestBody/content/application~1json/example":{"value":{"status":"blocked","blockedReason":"Waiting on their legal team"},"id":"paths/~1api~1v1~1actions~1plans~1{id}~1steps~1{stepId}~1status/post/requestBody/content/application~1json/example"},"paths/~1api~1v1~1actions~1plans~1{id}~1steps~1{stepId}~1status/post/responses/200/content/application~1json/example":{"value":{"ok":true,"data":{"id":"Pln5tH8jKw2qR6mX9vBz","url":"https://hrcledger.com/actions/items/Pln5tH8jKw2qR6mX9vBz","title":"Win Inova","objective":"Win the Inova imaging contract","archived":false,"steps":[{"id":"t_Ab3dE5fG","title":"Call the CFO","status":"in_progress","assignee":{"userId":7,"label":null},"dueDate":"2026-10-21","blockedReason":null},{"id":"t_Hj7kL9mN","title":"Send the security review","status":"blocked","assignee":{"userId":null,"label":"Dana at Inova"},"dueDate":null,"blockedReason":"Waiting on their legal team"}],"revisionNo":3,"updatedAt":"2026-10-16T14:02:11.000Z"}},"id":"paths/~1api~1v1~1actions~1plans~1{id}~1steps~1{stepId}~1status/post/responses/200/content/application~1json/example"},"paths/~1api~1v1~1actions~1plans~1{id}~1archive/post/requestBody/content/application~1json/example":{"value":{},"id":"paths/~1api~1v1~1actions~1plans~1{id}~1archive/post/requestBody/content/application~1json/example"},"paths/~1api~1v1~1actions~1plans~1{id}~1archive/post/responses/200/content/application~1json/example":{"value":{"ok":true,"data":{"id":"Pln5tH8jKw2qR6mX9vBz","url":"https://hrcledger.com/actions/items/Pln5tH8jKw2qR6mX9vBz","title":"Win Inova","objective":"Win the Inova imaging contract","archived":true,"steps":[{"id":"t_Ab3dE5fG","title":"Call the CFO","status":"in_progress","assignee":{"userId":7,"label":null},"dueDate":"2026-10-21","blockedReason":null},{"id":"t_Hj7kL9mN","title":"Send the security review","status":"blocked","assignee":{"userId":null,"label":"Dana at Inova"},"dueDate":null,"blockedReason":"Waiting on their legal team"}],"revisionNo":3,"updatedAt":"2026-10-16T14:02:11.000Z"}},"id":"paths/~1api~1v1~1actions~1plans~1{id}~1archive/post/responses/200/content/application~1json/example"},"paths/~1api~1v1~1drafts/get/responses/200/content/application~1json/example":{"value":{"ok":true,"data":{"items":[{"id":"Drf5tH8jKw2qR6mX9vBz","url":"https://hrcledger.com/drafts/items/Drf5tH8jKw2qR6mX9vBz","title":"Imaging at Inova","purpose":"email","audience":"Inova's CIO","evidence":[{"type":"organization","key":"41","url":"https://hrcledger.com/orgs/inova"}],"approval":{"revisionNo":3,"at":"2026-10-16T14:02:11.000Z"},"archived":false,"revisionNo":3,"updatedAt":"2026-10-16T14:02:11.000Z"}],"nextCursor":null,"total":null}},"id":"paths/~1api~1v1~1drafts/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1drafts/post/requestBody/content/application~1json/example":{"value":{"subject":"Imaging at Inova","purpose":"email","audience":"Inova's CIO","body":"We help imaging teams cut wait times."},"id":"paths/~1api~1v1~1drafts/post/requestBody/content/application~1json/example"},"paths/~1api~1v1~1drafts/post/responses/200/content/application~1json/example":{"value":{"ok":true,"data":{"id":"Drf5tH8jKw2qR6mX9vBz","url":"https://hrcledger.com/drafts/items/Drf5tH8jKw2qR6mX9vBz","title":"Imaging at Inova","purpose":"email","audience":"Inova's CIO","sections":[{"id":"s_Ab3dE5fG","heading":null,"text":"We help imaging teams cut wait times."}],"subject":"Imaging at Inova","body":"We help imaging teams cut wait times.","evidence":[],"approval":null,"archived":false,"revisionNo":1,"updatedAt":"2026-10-16T14:02:11.000Z"}},"id":"paths/~1api~1v1~1drafts/post/responses/200/content/application~1json/example"},"paths/~1api~1v1~1drafts/post/responses/201/content/application~1json/example":{"value":{"ok":true,"data":{"id":"Drf5tH8jKw2qR6mX9vBz","url":"https://hrcledger.com/drafts/items/Drf5tH8jKw2qR6mX9vBz","title":"Imaging at Inova","purpose":"email","audience":"Inova's CIO","sections":[{"id":"s_Ab3dE5fG","heading":null,"text":"We help imaging teams cut wait times."}],"subject":"Imaging at Inova","body":"We help imaging teams cut wait times.","evidence":[],"approval":null,"archived":false,"revisionNo":1,"updatedAt":"2026-10-16T14:02:11.000Z"}},"id":"paths/~1api~1v1~1drafts/post/responses/201/content/application~1json/example"},"paths/~1api~1v1~1drafts~1approved/get/responses/200/content/application~1json/example":{"value":{"ok":true,"data":{"items":[{"id":"Drf5tH8jKw2qR6mX9vBz","url":"https://hrcledger.com/drafts/items/Drf5tH8jKw2qR6mX9vBz","title":"Imaging at Inova","purpose":"email","audience":"Inova's CIO","sections":[{"id":"s_Ab3dE5fG","heading":"Why now","text":"Inova posted an imaging contract on [SAM.gov](ledger:contract:va-imaging-2026)."},{"id":"s_Hj7kL9mN","heading":null,"text":"Could we talk next week?\n\nBest, Alex"}],"subject":"Imaging at Inova","body":"Why now\n\nInova posted an imaging contract on [SAM.gov](https://hrcledger.com/contracts/va-imaging-2026).\n\nCould we talk next week?\n\nBest, Alex","evidence":[{"type":"organization","key":"41","url":"https://hrcledger.com/orgs/inova"}],"approval":{"revisionNo":3,"at":"2026-10-16T14:02:11.000Z"},"archived":false,"revisionNo":3,"updatedAt":"2026-10-16T14:02:11.000Z"}],"nextCursor":null,"total":null}},"id":"paths/~1api~1v1~1drafts~1approved/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1drafts~1{id}/get/responses/200/content/application~1json/example":{"value":{"ok":true,"data":{"id":"Drf5tH8jKw2qR6mX9vBz","url":"https://hrcledger.com/drafts/items/Drf5tH8jKw2qR6mX9vBz","title":"Imaging at Inova","purpose":"email","audience":"Inova's CIO","sections":[{"id":"s_Ab3dE5fG","heading":"Why now","text":"Inova posted an imaging contract on [SAM.gov](ledger:contract:va-imaging-2026)."},{"id":"s_Hj7kL9mN","heading":null,"text":"Could we talk next week?\n\nBest, Alex"}],"subject":"Imaging at Inova","body":"Why now\n\nInova posted an imaging contract on [SAM.gov](https://hrcledger.com/contracts/va-imaging-2026).\n\nCould we talk next week?\n\nBest, Alex","evidence":[{"type":"organization","key":"41","url":"https://hrcledger.com/orgs/inova"}],"approval":{"revisionNo":3,"at":"2026-10-16T14:02:11.000Z"},"archived":false,"revisionNo":3,"updatedAt":"2026-10-16T14:02:11.000Z"}},"id":"paths/~1api~1v1~1drafts~1{id}/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1drafts~1{id}/patch/requestBody/content/application~1json/example":{"value":{"expectedRevisionNo":3,"ops":[{"op":"update_section","sectionId":"s_Hj7kL9mN","text":"Could we talk Thursday?\n\nBest, Alex"}]},"id":"paths/~1api~1v1~1drafts~1{id}/patch/requestBody/content/application~1json/example"},"paths/~1api~1v1~1drafts~1{id}/patch/responses/200/content/application~1json/example":{"value":{"ok":true,"data":{"id":"Drf5tH8jKw2qR6mX9vBz","url":"https://hrcledger.com/drafts/items/Drf5tH8jKw2qR6mX9vBz","title":"Imaging at Inova","purpose":"email","audience":"Inova's CIO","sections":[{"id":"s_Ab3dE5fG","heading":"Why now","text":"Inova posted an imaging contract on [SAM.gov](ledger:contract:va-imaging-2026)."},{"id":"s_Hj7kL9mN","heading":null,"text":"Could we talk next week?\n\nBest, Alex"}],"subject":"Imaging at Inova","body":"Why now\n\nInova posted an imaging contract on [SAM.gov](https://hrcledger.com/contracts/va-imaging-2026).\n\nCould we talk next week?\n\nBest, Alex","evidence":[{"type":"organization","key":"41","url":"https://hrcledger.com/orgs/inova"}],"approval":null,"archived":false,"revisionNo":4,"updatedAt":"2026-10-16T14:02:11.000Z"}},"id":"paths/~1api~1v1~1drafts~1{id}/patch/responses/200/content/application~1json/example"},"paths/~1api~1v1~1drafts~1{id}~1archive/post/requestBody/content/application~1json/example":{"value":{},"id":"paths/~1api~1v1~1drafts~1{id}~1archive/post/requestBody/content/application~1json/example"},"paths/~1api~1v1~1drafts~1{id}~1archive/post/responses/200/content/application~1json/example":{"value":{"ok":true,"data":{"id":"Drf5tH8jKw2qR6mX9vBz","url":"https://hrcledger.com/drafts/items/Drf5tH8jKw2qR6mX9vBz","title":"Imaging at Inova","purpose":"email","audience":"Inova's CIO","sections":[{"id":"s_Ab3dE5fG","heading":"Why now","text":"Inova posted an imaging contract on [SAM.gov](ledger:contract:va-imaging-2026)."},{"id":"s_Hj7kL9mN","heading":null,"text":"Could we talk next week?\n\nBest, Alex"}],"subject":"Imaging at Inova","body":"Why now\n\nInova posted an imaging contract on [SAM.gov](https://hrcledger.com/contracts/va-imaging-2026).\n\nCould we talk next week?\n\nBest, Alex","evidence":[{"type":"organization","key":"41","url":"https://hrcledger.com/orgs/inova"}],"approval":{"revisionNo":3,"at":"2026-10-16T14:02:11.000Z"},"archived":true,"revisionNo":3,"updatedAt":"2026-10-16T14:02:11.000Z"}},"id":"paths/~1api~1v1~1drafts~1{id}~1archive/post/responses/200/content/application~1json/example"},"paths/~1api~1v1~1reviews~1{artifactId}~1approve/post/requestBody/content/application~1json/example":{"value":{"revisionNo":3},"id":"paths/~1api~1v1~1reviews~1{artifactId}~1approve/post/requestBody/content/application~1json/example"},"paths/~1api~1v1~1reviews~1{artifactId}~1approve/post/responses/200/content/application~1json/example":{"value":{"ok":true,"data":{"id":"Drf8pQ2rT4vW6xY9zA1b","kind":"draft","url":"https://hrcledger.com/drafts/items/Drf8pQ2rT4vW6xY9zA1b","revisionNo":3}},"id":"paths/~1api~1v1~1reviews~1{artifactId}~1approve/post/responses/200/content/application~1json/example"},"paths/~1api~1v1~1conversations/get/responses/200/content/application~1json/example":{"value":{"ok":true,"data":{"items":[{"id":"Cnv7pQ2rS4tU6vW8xY0z","url":"https://hrcledger.com/ask/Cnv7pQ2rS4tU6vW8xY0z","title":"Ohio EHR changes","turnCount":2,"awaitingAnswer":false,"updatedAt":"2026-10-16T14:02:11.000Z"}],"nextCursor":null,"total":null}},"id":"paths/~1api~1v1~1conversations/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1conversations~1{id}/get/responses/200/content/application~1json/example":{"value":{"ok":true,"data":{"id":"Cnv7pQ2rS4tU6vW8xY0z","url":"https://hrcledger.com/ask/Cnv7pQ2rS4tU6vW8xY0z","title":"Ohio EHR changes","turns":{"items":[{"turn":1,"runId":"run1aB3dE5fGhJ7kL9mNp","status":"complete","question":"Which Ohio hospitals changed EHR vendor this year?","answer":"Two did: Inova and Mercy Health.","citations":[{"type":"organization","key":"41","url":"https://hrcledger.com/orgs/inova"}],"artifacts":[],"createdAt":"2026-10-16T13:58:02.000Z"},{"turn":2,"runId":"run2aB3dE5fGhJ7kL9mNp","status":"complete","question":"Save them as a List.","answer":"Saved them as the List Ohio EHR changes.","citations":[{"type":"organization","key":"41","url":"https://hrcledger.com/orgs/inova"}],"artifacts":[{"kind":"list","id":"Lst2mN4pQ6rS8tU0vW2x","url":"https://hrcledger.com/lists/items/Lst2mN4pQ6rS8tU0vW2x"}],"createdAt":"2026-10-16T14:02:11.000Z"}],"nextCursor":null,"total":2},"createdAt":"2026-10-16T13:58:02.000Z","updatedAt":"2026-10-16T14:02:11.000Z"}},"id":"paths/~1api~1v1~1conversations~1{id}/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1conversations~1{id}/patch/requestBody/content/application~1json/example":{"value":{"title":"Ohio EHR changes"},"id":"paths/~1api~1v1~1conversations~1{id}/patch/requestBody/content/application~1json/example"},"paths/~1api~1v1~1conversations~1{id}/patch/responses/200/content/application~1json/example":{"value":{"ok":true,"data":{"id":"Cnv7pQ2rS4tU6vW8xY0z","url":"https://hrcledger.com/ask/Cnv7pQ2rS4tU6vW8xY0z","title":"Ohio EHR changes","turnCount":2,"awaitingAnswer":false,"updatedAt":"2026-10-16T14:02:11.000Z"}},"id":"paths/~1api~1v1~1conversations~1{id}/patch/responses/200/content/application~1json/example"},"paths/~1api~1v1~1memory/get/responses/200/content/application~1json/example":{"value":{"ok":true,"data":{"entries":[{"id":"Mem4kL6mN8pQ0rS2tU4v","kind":"offer","about":"What you sell","basis":"stated","says":"Revenue cycle audits for community hospitals","source":{"kind":"person","label":null},"updatedAt":"2026-10-16T14:02:11.000Z"}],"total":1}},"id":"paths/~1api~1v1~1memory/get/responses/200/content/application~1json/example"},"paths/~1api~1v1~1ask/post/requestBody/content/application~1json/example":{"value":{"question":"Which Ohio hospitals changed EHR vendor this year?","contract":"general"},"id":"paths/~1api~1v1~1ask/post/requestBody/content/application~1json/example"},"paths/~1api~1v1~1ask/post/responses/200/content/application~1json/example":{"value":{"ok":true,"data":{"run":{"id":"Ab3-_cD9efGhIjKlMnOpQ","url":"https://hrcledger.com/runs/Ab3-_cD9efGhIjKlMnOpQ","status":"complete","contract":"general","stopped_reason":null,"partial_note":null},"conversation":{"id":"Zx9-_aB8cdEfGhIjKlMnO","url":"https://hrcledger.com/ask/Zx9-_aB8cdEfGhIjKlMnO","turn":1},"answer":"Two Ohio hospitals posted an EHR replacement this year.","citations":[{"claim":"Two Ohio hospitals posted an EHR replacement this year.","record":{"type":"contract","key":"oh-mercy-ehr-2026"},"url":"https://hrcledger.com/contracts/oh-mercy-ehr-2026","absence":null}],"rows":[{"type":"contract","key":"oh-mercy-ehr-2026","row":{"title":"Electronic health record replacement"}}],"coverage":{"views":[{"view":"agent.contracts","rows_returned":2}],"steps":3,"note":"What this answer is built on: query: 2 rows.","unreadable":0},"usage":{"cost_cents":4,"input_tokens":12000,"output_tokens":400,"cached_tokens":9000},"feedback":{"url":"/api/agent/feedback","run":"Ab3-_cD9efGhIjKlMnOpQ","controls":["rating","used"]}}},"id":"paths/~1api~1v1~1ask/post/responses/200/content/application~1json/example"}},"securitySchemeStore":{"bearerKey":{"id":"bearerKey","type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hck_live_..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Scopes are per key: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contracts:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"market:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent:ask"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"servers":[{"url":"/_mock/docs/openapi","isMockServer":true,"description":"Mock server"},{"url":"https://hrcledger.com"}],"specType":"openapi"},"options":{"codeSamples":{"skipOptionalParameters":true,"languages":[{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Python"}]},"hideDownloadButtons":false,"mockServer":{"url":"/_mock/docs/openapi","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/docs/openapi.json?download"},{"url":"/_bundle/docs/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"HRC Ledger API","description":"The HRC Ledger API gives a healthcare investment banker's own code what HRC Ledger holds: healthcare organizations and public contracts, your saved Lists, action plans, drafts and conversations, and the HRC Ledger assistant.\n\n**Authenticate** with an API key in one header: `Authorization: Bearer hck_live_...`. A key works on any plan; each key carries the scopes it was made with.\n\n**One envelope** on every route: `{ ok: true, data, page?, total? }`, or `{ ok: false, error: { code, message, ...details } }`. Every response carries an `X-Request-Id` header; quote it when you ask us about a call.\n\n**Versioning is in the path** (`/api/v1`): a change that removes or retypes a field in `data` ships at a new path; adding a field does not.\n\n**Guides** — getting started, keys and scopes, errors, pagination and versioning, and the changelog — are at https://docs.hrcledger.com/developer/."}},"baseSlug":"/docs/openapi","routesMapping":{}}