{"openapi":"3.1.0","info":{"title":"Advocate OS API","version":"2026-12-01","description":"Indian court data, research, reports, monitoring and AI for legal work. Prices are in credits (\u20b91 before GST); failed and empty calls are free."},"servers":[{"url":"https:\/\/adv.heliosynctech.com\/api\/v1"}],"security":[{"bearer":[]}],"externalDocs":{"url":"https:\/\/adv.heliosynctech.com\/developers"},"paths":{"\/account":{"get":{"operationId":"getAccount","tags":["Account"],"summary":"The account, its plan, limits and credits","x-aos-price":"free","responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Account"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/acts\/{act}\/sections\/{n}":{"get":{"operationId":"getActSection","tags":["Law"],"x-aos-price":"0.05 credit (law.section)","summary":"A section of a bare act","parameters":[{"name":"act","in":"path","required":true,"schema":{"type":"string"},"description":"A short name (IPC, BNS, CrPC, NI \u2026) or an act id."},{"name":"n","in":"path","required":true,"schema":{"type":"string"},"description":"The section number, like 138 or 498A."}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ActSection"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"402":{"$ref":"#\/components\/responses\/PaymentRequired"},"404":{"$ref":"#\/components\/responses\/NotFound"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/case-types":{"get":{"operationId":"listCaseTypes","tags":["Court"],"x-aos-price":"free","summary":"Case types seen in the stored records, most common first","parameters":[{"$ref":"#\/components\/parameters\/Limit"},{"$ref":"#\/components\/parameters\/Cursor"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/List"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/CaseType"}}}}]}}}},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/cases":{"get":{"operationId":"searchCases","tags":["Court"],"x-aos-price":"0.60 credits a search (court.case.search); free when nothing is found","summary":"Search cases by party, advocate or number","description":"Searches the case records the platform holds (test keys: the Sandbox High Court). Give at least one of party, advocate, number. `party` and `advocate` search by a person's name: they need an account that has paid once (403 paid_account_required), are logged on the firm's audit trail, and never return a protected case (POCSO, sexual offences, matrimonial, juvenile). Advocate search covers cases that appear in published cause lists.","parameters":[{"name":"party","in":"query","schema":{"type":"string","minLength":3},"description":"A party name, at least 3 characters (needs a paid account)."},{"name":"advocate","in":"query","schema":{"type":"string","minLength":3},"description":"An advocate's name, at least 3 characters (needs a paid account)."},{"name":"number","in":"query","schema":{"type":"string"},"description":"Part of the case number, like 158\/2024 or \"CS 158\"."},{"name":"year","in":"query","schema":{"type":"string","pattern":"^[0-9]{4}$"},"description":"Registration year."},{"name":"court","in":"query","schema":{"type":"string"},"description":"Part of the court name (test keys: SBHC, SBHC-P, SBHC-N, SBHC-S)."},{"$ref":"#\/components\/parameters\/Limit"},{"$ref":"#\/components\/parameters\/Cursor"},{"$ref":"#\/components\/parameters\/SandboxDate"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/List"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/Case"}}}}]}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"402":{"$ref":"#\/components\/responses\/PaymentRequired"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/cases\/{cnr}":{"get":{"operationId":"getCase","tags":["Court"],"x-aos-price":"1.00 credit (court.case.detail); 2.50 with fresh=true (court.case.refresh)","summary":"A case by CNR, with its orders listed","description":"A plain call is always 1.00 credit: a stored record up to 24 hours old is served as it is (`cached: true`); a missing or older one is read from the court portal first (`cached: false`). If the portal cannot be read, a plain call falls back to the stored record (`stale: true`, 1.00 credit), or answers 503 and charges nothing when none is stored. `fresh=true` always reads the portal (2.50 credits) and answers 503, free, when it cannot. Protected categories have their party names masked. The response header AOS-Credits-Charged shows which price applied.","parameters":[{"name":"cnr","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z]{4}[0-9]{12}$"},"description":"The 16-character CNR. Test keys: SBXX010000012026 (pending), \u202602 (disposed), \u202603 (a new order every day), \u202604 (portal down, 503), \u202605 (protected category, names masked), SBXX019999992026 (not found)."},{"name":"fresh","in":"query","schema":{"type":"boolean"},"description":"Read the court portal now instead of the stored record (2.50 credits)."},{"$ref":"#\/components\/parameters\/SandboxDate"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Case"}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"402":{"$ref":"#\/components\/responses\/PaymentRequired"},"404":{"$ref":"#\/components\/responses\/NotFound"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"},"503":{"$ref":"#\/components\/responses\/UpstreamUnavailable"}}}},"\/cases\/{cnr}\/orders":{"get":{"operationId":"listCaseOrders","tags":["Court"],"x-aos-price":"free","summary":"The orders of a case, newest first, without text","description":"A live case must already be stored: read it once with GET \/cases\/{cnr}.","parameters":[{"name":"cnr","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z]{4}[0-9]{12}$"},"description":"The 16-character CNR. Test keys: SBXX010000012026 (pending), \u202602 (disposed), \u202603 (a new order every day), \u202604 (portal down, 503), \u202605 (protected category, names masked), SBXX019999992026 (not found)."},{"$ref":"#\/components\/parameters\/Limit"},{"$ref":"#\/components\/parameters\/Cursor"},{"$ref":"#\/components\/parameters\/SandboxDate"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/List"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/Order"}}}}]}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"404":{"$ref":"#\/components\/responses\/NotFound"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"},"503":{"$ref":"#\/components\/responses\/UpstreamUnavailable"}}}},"\/cause-lists":{"get":{"operationId":"listCauseLists","tags":["Court"],"x-aos-price":"1.00 credit per list returned (court.causelist)","summary":"Published cause lists of a day","description":"The lists of a court for a date (default today, IST), optionally only entries matching `q` (case number or party). A list with no matching entry is not returned and not charged. At most 2,000 entries per list; narrow with `q` when `entries_truncated` is true.","parameters":[{"name":"court","in":"query","schema":{"type":"string"},"description":"A cause-list court code from GET \/courts (sc, dhc, \u2026; test keys: SBHC, SBHC-P, SBHC-N, SBHC-S)."},{"name":"date","in":"query","schema":{"type":"string","format":"date"},"description":"Default today (test keys: the sandbox date)."},{"name":"q","in":"query","schema":{"type":"string","minLength":3},"description":"A case number or party name, at least 3 characters."},{"$ref":"#\/components\/parameters\/Limit"},{"$ref":"#\/components\/parameters\/Cursor"},{"$ref":"#\/components\/parameters\/SandboxDate"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/List"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/CauseList"}}}}]}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"402":{"$ref":"#\/components\/responses\/PaymentRequired"},"404":{"$ref":"#\/components\/responses\/NotFound"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/cause-lists\/match":{"post":{"operationId":"matchCauseLists","tags":["Court"],"x-aos-price":"0.10 credit per CNR checked (court.causelist.match); free when none is listed","summary":"Which of these cases are listed on a date","parameters":[{"$ref":"#\/components\/parameters\/IdempotencyKey"},{"$ref":"#\/components\/parameters\/SandboxDate"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","required":["cnrs","date"],"properties":{"cnrs":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"string"}},"date":{"type":"string","format":"date"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/List"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/CauseListMatch"}}}}]}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"402":{"$ref":"#\/components\/responses\/PaymentRequired"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/citations\/check":{"post":{"operationId":"checkCitations","tags":["Research"],"x-aos-price":"1.00 credit per citation found (research.citation.check); free when the text has none","summary":"Check every citation in a text against the library","description":"Each authority is read with the case name before it and marked verified (the citation is that case), mismatch (the citation is a different case) or unknown (not in the library). At most 200 citations a call.","parameters":[{"$ref":"#\/components\/parameters\/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","required":["text"],"properties":{"text":{"type":"string","maxLength":100000,"example":"Arnesh Kumar v. State of Bihar, (2014) 8 SCC 273"}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CitationCheck"}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"402":{"$ref":"#\/components\/responses\/PaymentRequired"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/code-map":{"get":{"operationId":"getCodeMap","tags":["Law"],"x-aos-price":"0.10 credit (law.codemap)","summary":"The same section in the old and new criminal codes","description":"IPC \u21c4 BNS, CrPC \u21c4 BNSS, IEA \u21c4 BSA, either direction. A section with no counterpart answers 404 mapping_not_found and is not charged.","parameters":[{"name":"act","in":"query","required":true,"schema":{"type":"string","enum":["IPC","CrPC","IEA","BNS","BNSS","BSA"]}},{"name":"section","in":"query","required":true,"schema":{"type":"string"},"example":"302"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CodeMap"}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"402":{"$ref":"#\/components\/responses\/PaymentRequired"},"404":{"$ref":"#\/components\/responses\/NotFound"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/court-fee":{"post":{"operationId":"calculateCourtFee","tags":["Court"],"x-aos-price":"0.50 credit (court.fee)","summary":"Court fee on a plaint, by State","description":"Worked in code from each State's Court Fees Act (Rules\\CourtFee). A State whose Act could not be confirmed answers 400 state_not_supported.","parameters":[{"$ref":"#\/components\/parameters\/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","required":["state","value"],"properties":{"state":{"type":"string","example":"Karnataka"},"value":{"type":"number","description":"Value of the suit in rupees.","example":500000}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CourtFee"}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"402":{"$ref":"#\/components\/responses\/PaymentRequired"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/courts":{"get":{"operationId":"listCourts","tags":["Court"],"x-aos-price":"free","summary":"The Supreme Court, High Courts and tribunals","parameters":[{"$ref":"#\/components\/parameters\/Limit"},{"$ref":"#\/components\/parameters\/Cursor"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/List"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/CourtInfo"}}}}]}}}},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/drafts":{"post":{"operationId":"createDraft","tags":["Intelligence"],"summary":"Draft a document from a blueprint and its facts","x-aos-price":"ai.draft: 10 a draft","parameters":[{"$ref":"#\/components\/parameters\/IdempotencyKey"}],"description":"The model writes the prose; code writes the formal parts. The draft also opens in the firm's Drafting Studio for review.","requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","required":["blueprint"],"properties":{"blueprint":{"type":"string","description":"A key from GET \/drafts\/blueprints."},"facts":{"type":"object","additionalProperties":{"type":["string","number"]},"description":"The blueprint's fields by name."},"language":{"type":"string","enum":["en","hi"],"default":"en"},"parties":{"type":"object","properties":{"first":{"type":"array","items":{"$ref":"#\/components\/schemas\/Party"}},"second":{"type":"array","items":{"$ref":"#\/components\/schemas\/Party"}}}},"mode":{"type":"string","enum":["batch"],"description":"Not supported here: \"batch\" answers 400 batch_not_supported (POST \/records\/read batches)."}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Draft"}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"402":{"$ref":"#\/components\/responses\/PaymentRequired"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"},"503":{"$ref":"#\/components\/responses\/UpstreamUnavailable"}}}},"\/drafts\/blueprints":{"get":{"operationId":"listBlueprints","tags":["Intelligence"],"summary":"The drafting blueprints and the facts each needs","x-aos-price":"free","responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/List"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/Blueprint"}}}}]}}}},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/events":{"get":{"operationId":"listEvents","tags":["Events"],"summary":"The event log, oldest first (the CLI listen command polls it)","x-aos-price":"free","description":"Events of the key's mode (each carries `mode`, test or live: the same body a webhook delivery sends). Pass after=<last event id> to get only newer events. A test key with a later AOS-Sandbox-Date first brings in the news of the watched sandbox cases.","parameters":[{"name":"after","in":"query","schema":{"type":"string","pattern":"^evt_[A-Za-z0-9]{24}$"},"description":"Only events after this one."},{"name":"type","in":"query","schema":{"type":"string","enum":["case.updated","case.next_date_changed","case.disposed","order.published","causelist.listed","party.new_case","report.completed","report.failed","job.completed","job.failed","webhook.test","board.item_called"]}},{"$ref":"#\/components\/parameters\/Limit"},{"$ref":"#\/components\/parameters\/Cursor"},{"$ref":"#\/components\/parameters\/SandboxDate"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/List"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/Event"}}}}]}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/events\/{id}":{"get":{"operationId":"getEvent","tags":["Events"],"summary":"One event","x-aos-price":"free","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^evt_[A-Za-z0-9]{24}$"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Event"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/holidays":{"get":{"operationId":"listHolidays","tags":["Court"],"x-aos-price":"free","summary":"Court holidays of a year","description":"The three fixed national holidays, plus the court's published list where the platform holds it. Weekends are not listed.","parameters":[{"name":"court","in":"query","schema":{"type":"string"},"description":"A holiday key or court code from GET \/courts (sc, hc:delhi, dhc)."},{"name":"year","in":"query","schema":{"type":"string","pattern":"^[0-9]{4}$"},"description":"Default this year."},{"$ref":"#\/components\/parameters\/Limit"},{"$ref":"#\/components\/parameters\/Cursor"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/List"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/Holiday"}}}}]}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/jobs\/{id}":{"get":{"operationId":"getJob","tags":["Intelligence"],"summary":"An async job, with its result once completed","x-aos-price":"free","description":"Events job.completed and job.failed are sent when it ends. Pages are charged on completion; a failed job is free.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^job_[A-Za-z0-9]{24}$"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Job"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/judgments":{"get":{"operationId":"searchJudgments","tags":["Research"],"x-aos-price":"0.50 credits a search (research.judgment.search); free when nothing is found","summary":"Search judgments of the Supreme Court, High Courts and tribunals","description":"The library's own search: words, \"phrases\", -exclusions, party:, judge:, citation:, \"section 138 NI Act\", court: and year: clauses. The same real library with test and live keys; test keys are free.","parameters":[{"name":"q","in":"query","schema":{"type":"string","minLength":2,"maxLength":300},"description":"The search, 2 to 300 characters.","required":true},{"name":"court","in":"query","schema":{"type":"string"},"description":"sc, hc, or a High Court name such as Delhi."},{"name":"from","in":"query","schema":{"type":"string","format":"date"},"description":"Decided on or after (yyyy-MM-dd)."},{"name":"to","in":"query","schema":{"type":"string","format":"date"},"description":"Decided on or before (yyyy-MM-dd)."},{"$ref":"#\/components\/parameters\/Limit"},{"$ref":"#\/components\/parameters\/Cursor"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/List"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/JudgmentHit"}}}}]}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"402":{"$ref":"#\/components\/responses\/PaymentRequired"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/judgments\/{id}":{"get":{"operationId":"getJudgment","tags":["Research"],"x-aos-price":"0.30 credit (research.judgment); free when the library has no text yet","summary":"A judgment with its paragraphs, labelled for citing","description":"Up to 300 paragraphs a call; when `next_from` is not null call again with `from=next_from`.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"A judgment id from GET \/judgments."},{"name":"from","in":"query","schema":{"type":"integer","minimum":1},"description":"First paragraph position."},{"name":"to","in":"query","schema":{"type":"integer","minimum":1},"description":"Last paragraph position."}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/JudgmentFull"}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"402":{"$ref":"#\/components\/responses\/PaymentRequired"},"404":{"$ref":"#\/components\/responses\/NotFound"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/judgments\/{id}\/citator":{"get":{"operationId":"getJudgmentCitator","tags":["Research"],"x-aos-price":"2.00 credits (research.citator)","summary":"How later judgments treat this one","description":"Counts of citing judgments by treatment (followed, distinguished, overruled), and the citing judgments, newest first. By code: a flag says \"check this paragraph\", not that the law is bad.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"A judgment id from GET \/judgments."},{"$ref":"#\/components\/parameters\/Limit"},{"$ref":"#\/components\/parameters\/Cursor"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Citator"}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"402":{"$ref":"#\/components\/responses\/PaymentRequired"},"404":{"$ref":"#\/components\/responses\/NotFound"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/limitation":{"post":{"operationId":"calculateLimitation","tags":["Law"],"x-aos-price":"1.00 credit (law.limitation)","summary":"The last day to file, with every step","description":"Counted in code (Limitation Act s.12 and s.4, General Clauses Act): the start day is excluded, a last day on which the court is closed moves to the next day it sits. Check the provision before relying on a date.","parameters":[{"$ref":"#\/components\/parameters\/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","required":["rule","start"],"properties":{"rule":{"type":"string","example":"cpc_appeal_hc"},"start":{"type":"string","format":"date"},"copy_applied":{"type":"string","format":"date","description":"Date a certified copy was applied for (with copy_ready)."},"copy_ready":{"type":"string","format":"date"},"court":{"type":"string","description":"A holiday key or court code from GET \/courts, for that court's holidays."}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Limitation"}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"402":{"$ref":"#\/components\/responses\/PaymentRequired"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/limitation\/rules":{"get":{"operationId":"listLimitationRules","tags":["Law"],"x-aos-price":"free","summary":"The limitation periods and statutory timelines the calculator knows","parameters":[{"$ref":"#\/components\/parameters\/Limit"},{"$ref":"#\/components\/parameters\/Cursor"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/List"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/LimitationRule"}}}}]}}}},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/ocr":{"post":{"operationId":"runOcr","tags":["Intelligence"],"summary":"Read a scanned PDF or image page by page","x-aos-price":"ai.ocr: 0.40 a page (from 1,00,000: 0.35)","parameters":[{"$ref":"#\/components\/parameters\/IdempotencyKey"}],"description":"Up to 10 pages answers now; more becomes a job. Pages are billed as read; a failure is free.","requestBody":{"required":true,"content":{"multipart\/form-data":{"schema":{"type":"object","required":["file"],"properties":{"file":{"type":"string","format":"binary","description":"At most 50 MB."},"mode":{"type":"string","enum":["batch"],"description":"Batch: always a job, 50% of list. Only POST \/records\/read takes it."}}}}}},"responses":{"200":{"description":"Answered now (small files)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Ocr"}}}},"202":{"description":"Accepted: a job; poll GET \/jobs\/{id} or wait for job.completed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Job"}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"402":{"$ref":"#\/components\/responses\/PaymentRequired"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"},"503":{"$ref":"#\/components\/responses\/UpstreamUnavailable"}}}},"\/orders\/{id}":{"get":{"operationId":"getOrder","tags":["Court"],"x-aos-price":"1.50 credits (court.order); free when the text is withheld or not read yet","summary":"The text of an order","description":"Reads the stored text of an order. The text of an order in a protected category is withheld (`withheld: true`).","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"An order id from a case: ord_123, or sbx_\u2026 in the sandbox."},{"$ref":"#\/components\/parameters\/SandboxDate"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/OrderText"}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"402":{"$ref":"#\/components\/responses\/PaymentRequired"},"404":{"$ref":"#\/components\/responses\/NotFound"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/orders\/{id}\/pdf":{"get":{"operationId":"getOrderPdf","tags":["Court"],"x-aos-price":"1.50 credits (court.order)","summary":"The PDF of an order","description":"404 order_pdf_unavailable until the platform has stored the PDF (it downloads them after a case is read); 403 protected_category for a protected case.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"An order id from a case."},{"$ref":"#\/components\/parameters\/SandboxDate"}],"responses":{"200":{"description":"The order as a PDF.","headers":{"AOS-Request-Id":{"$ref":"#\/components\/headers\/AOS-Request-Id"},"AOS-Mode":{"$ref":"#\/components\/headers\/AOS-Mode"},"AOS-Credits-Charged":{"$ref":"#\/components\/headers\/AOS-Credits-Charged"},"RateLimit-Limit":{"$ref":"#\/components\/headers\/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#\/components\/headers\/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#\/components\/headers\/RateLimit-Reset"}},"content":{"application\/pdf":{"schema":{"type":"string","format":"binary"}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"402":{"$ref":"#\/components\/responses\/PaymentRequired"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/orders\/{id}\/summary":{"get":{"operationId":"summariseOrder","tags":["Intelligence"],"summary":"An order's summary, outcome, next date and directions","x-aos-price":"ai.order.summary: 2.50 an order (a stored summary is reused: no AI cost)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"An order id from GET \/cases\/{cnr}\/orders (test keys: sbx_\u2026)."}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/OrderSummary"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"402":{"$ref":"#\/components\/responses\/PaymentRequired"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"},"409":{"$ref":"#\/components\/responses\/Conflict"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"},"503":{"$ref":"#\/components\/responses\/UpstreamUnavailable"}}}},"\/records\/digest":{"post":{"operationId":"digestRecord","tags":["Intelligence"],"summary":"Read a record and write its digest, parties and threads","x-aos-price":"ai.record.digest: 0.25 a page","parameters":[{"$ref":"#\/components\/parameters\/IdempotencyKey"}],"description":"Always a job.","requestBody":{"required":true,"content":{"multipart\/form-data":{"schema":{"type":"object","required":["files[]"],"properties":{"files[]":{"type":"array","items":{"type":"string","format":"binary","description":"At most 50 MB."},"minItems":1,"maxItems":20,"description":"PDFs, one per document of the record."},"matter":{"type":"string","maxLength":300,"description":"What the record is about (helps spot papers of another matter)."},"mode":{"type":"string","enum":["batch"],"description":"Batch: always a job, 50% of list. Only POST \/records\/read takes it."}}}}}},"responses":{"202":{"description":"Accepted","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Job"}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"402":{"$ref":"#\/components\/responses\/PaymentRequired"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"},"503":{"$ref":"#\/components\/responses\/UpstreamUnavailable"}}}},"\/records\/read":{"post":{"operationId":"readRecord","tags":["Intelligence"],"summary":"Read a record: a card and checked facts for each document","x-aos-price":"ai.record.read: 0.15 a page","parameters":[{"$ref":"#\/components\/parameters\/IdempotencyKey"}],"description":"Every fact cites its page; code checks the quote and amounts are on it. Up to 10 pages answers now; more, or \"mode\": \"batch\", becomes a job.","requestBody":{"required":true,"content":{"multipart\/form-data":{"schema":{"type":"object","required":["files[]"],"properties":{"files[]":{"type":"array","items":{"type":"string","format":"binary","description":"At most 50 MB."},"minItems":1,"maxItems":20,"description":"PDFs, one per document of the record."},"matter":{"type":"string","maxLength":300,"description":"What the record is about (helps spot papers of another matter)."},"mode":{"type":"string","enum":["batch"],"description":"Batch: always a job, 50% of list. Only POST \/records\/read takes it."}}}}}},"responses":{"200":{"description":"Answered now (small files)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Record"}}}},"202":{"description":"Accepted: a job; poll GET \/jobs\/{id} or wait for job.completed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Job"}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"402":{"$ref":"#\/components\/responses\/PaymentRequired"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"},"503":{"$ref":"#\/components\/responses\/UpstreamUnavailable"}}}},"\/reports":{"post":{"operationId":"createReport","tags":["Reports"],"x-aos-price":"litigation_check 79 credits (from 1,000 a month: 59; from 10,000 a month: 45); due_diligence 299 credits (from 500 a month: 249); charged when the report completes","summary":"Start a litigation check or a due-diligence report on a person or company","description":"Asynchronous: answers 202 with status `queued`. Poll GET \/reports\/{id} or listen for the `report.completed` \/ `report.failed` webhook. Charged when the report completes (a failed report is free). A person subject needs an account that has paid; test keys run on the Sandbox High Court (`Sandbox Lender` finds a fixed set).","parameters":[{"$ref":"#\/components\/parameters\/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ReportRequest"}}}},"responses":{"202":{"description":"Accepted: queued","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Report"}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"402":{"$ref":"#\/components\/responses\/PaymentRequired"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}},"get":{"operationId":"listReports","tags":["Reports"],"summary":"The account's reports, newest first (summary only)","x-aos-price":"free","parameters":[{"$ref":"#\/components\/parameters\/Limit"},{"$ref":"#\/components\/parameters\/Cursor"},{"name":"status","in":"query","schema":{"type":"string","enum":["queued","running","completed","failed"]}},{"name":"type","in":"query","schema":{"type":"string","enum":["litigation_check","due_diligence"]}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/List"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/Report"}}}}]}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/reports\/{id}":{"get":{"operationId":"getReport","tags":["Reports"],"summary":"A report: status, and when completed the summary, the hits and the PDF link","x-aos-price":"free","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^rpt_[A-Za-z0-9]{24}$"},"description":"The report id, rpt_\u2026 ."}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Report"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/reports\/{id}\/pdf":{"get":{"operationId":"getReportPdf","tags":["Reports"],"summary":"The report as a PDF with a verify QR (key auth)","x-aos-price":"free","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^rpt_[A-Za-z0-9]{24}$"},"description":"The report id, rpt_\u2026 ."}],"responses":{"200":{"description":"The PDF","headers":{"AOS-Request-Id":{"$ref":"#\/components\/headers\/AOS-Request-Id"},"AOS-Mode":{"$ref":"#\/components\/headers\/AOS-Mode"},"AOS-Credits-Charged":{"$ref":"#\/components\/headers\/AOS-Credits-Charged"},"RateLimit-Limit":{"$ref":"#\/components\/headers\/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#\/components\/headers\/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#\/components\/headers\/RateLimit-Reset"}},"content":{"application\/pdf":{"schema":{"type":"string","format":"binary"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"},"409":{"$ref":"#\/components\/responses\/Conflict"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/research\/answers":{"post":{"operationId":"answerResearch","tags":["Intelligence"],"summary":"Answer a legal question from the judgment and bare-act library","x-aos-price":"ai.research.answer: 25 an answer","parameters":[{"$ref":"#\/components\/parameters\/IdempotencyKey"}],"description":"Every statement cites the paragraphs (judgment id and paragraph label) or sections it stands on; statements without one are removed. With nothing in the library on the question the call refuses (404 no_material, free).","requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","required":["question"],"properties":{"question":{"type":"string","minLength":8,"maxLength":1000},"court":{"type":"string","description":"Only judgments whose court name contains this."},"mode":{"type":"string","enum":["batch"],"description":"Not supported here: \"batch\" answers 400 batch_not_supported (POST \/records\/read batches)."}}}}}},"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ResearchAnswer"}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"402":{"$ref":"#\/components\/responses\/PaymentRequired"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"},"503":{"$ref":"#\/components\/responses\/UpstreamUnavailable"}}}},"\/sandbox\/events":{"post":{"operationId":"emitSandboxEvent","tags":["Sandbox"],"summary":"Emit a test event to the test webhooks and event log","x-aos-price":"free","parameters":[{"$ref":"#\/components\/parameters\/SandboxDate"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["case.updated","case.next_date_changed","case.disposed","order.published","causelist.listed","party.new_case","report.completed","report.failed","job.completed","job.failed","webhook.test","board.item_called"]},"cnr":{"type":"string","description":"A sandbox CNR (default SBXX010000032026).","pattern":"^SBXX01[0-9]{6}2026$"}}}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Event"}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"},"503":{"$ref":"#\/components\/responses\/UpstreamUnavailable"}}}},"\/sandbox\/reset":{"post":{"operationId":"resetSandbox","tags":["Sandbox"],"summary":"Clear the account's test watches, events and deliveries","x-aos-price":"free","responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"sandbox_reset"},"deleted":{"type":"object","additionalProperties":{"type":"integer"}}}}}}},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/translate":{"post":{"operationId":"translate","tags":["Intelligence"],"summary":"Translate text or a PDF into English or Hindi, page by page","x-aos-price":"ai.translate: 2.00 a page (1 page = 2,000 characters)","parameters":[{"$ref":"#\/components\/parameters\/IdempotencyKey"}],"description":"text up to 2 pages answers now; longer text and every file become a job.","requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","required":["text","to"],"properties":{"text":{"type":"string","maxLength":1000000},"to":{"type":"string","enum":["en","hi"]},"from":{"type":"string","pattern":"^[a-z]{2,3}$","description":"ISO 639 code, optional."}}}},"multipart\/form-data":{"schema":{"type":"object","required":["file","to"],"properties":{"file":{"type":"string","format":"binary","description":"At most 50 MB."},"to":{"type":"string","enum":["en","hi"]},"from":{"type":"string"}}}}}},"responses":{"200":{"description":"Answered now (small files)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Translation"}}}},"202":{"description":"Accepted: a job; poll GET \/jobs\/{id} or wait for job.completed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Job"}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"402":{"$ref":"#\/components\/responses\/PaymentRequired"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"},"503":{"$ref":"#\/components\/responses\/UpstreamUnavailable"}}}},"\/tribunal-orders":{"get":{"operationId":"searchTribunalOrders","tags":["Court"],"x-aos-price":"0.60 credits a search (court.case.search); free when nothing is found","summary":"Search tribunal orders (NCLT, NCLAT, ITAT, CESTAT, NGT, CCI, CAT, AFT, APTEL, TDSAT)","parameters":[{"name":"forum","in":"query","schema":{"type":"string","enum":["nclat","nclt","itat","cestat","ngt","cci","cat","aft","aptel","tdsat"]},"description":"The tribunal."},{"name":"q","in":"query","schema":{"type":"string","minLength":3},"description":"Words from the title, case number or CNR."},{"$ref":"#\/components\/parameters\/Limit"},{"$ref":"#\/components\/parameters\/Cursor"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/List"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/TribunalOrder"}}}}]}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"402":{"$ref":"#\/components\/responses\/PaymentRequired"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/tribunal-orders\/{id}":{"get":{"operationId":"getTribunalOrder","tags":["Court"],"x-aos-price":"1.50 credits (court.tribunal.order); free when its text is not read yet","summary":"A tribunal order with its text","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"A tribunal order id from GET \/tribunal-orders."}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/TribunalOrderText"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"402":{"$ref":"#\/components\/responses\/PaymentRequired"},"404":{"$ref":"#\/components\/responses\/NotFound"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/usage":{"get":{"operationId":"getUsage","tags":["Account"],"summary":"Usage by endpoint or by day (IST)","x-aos-price":"free","parameters":[{"name":"from","in":"query","schema":{"type":"string","format":"date"},"description":"Default: the 1st of this month."},{"name":"to","in":"query","schema":{"type":"string","format":"date"},"description":"Default: today."},{"name":"group","in":"query","schema":{"type":"string","enum":["endpoint","day","request"],"default":"endpoint"},"description":"request: the request log, newest first, paged with limit and cursor."},{"$ref":"#\/components\/parameters\/Limit"},{"$ref":"#\/components\/parameters\/Cursor"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#\/components\/schemas\/List"},{"type":"object","properties":{"data":{"type":"array","items":{"oneOf":[{"$ref":"#\/components\/schemas\/Usage"},{"$ref":"#\/components\/schemas\/UsageRequest"}]}}}}]},{"type":"object","required":["from","to","group","total_credits"],"properties":{"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"group":{"type":"string","enum":["endpoint","day","request"]},"total_credits":{"type":"number","description":"Credits charged over the whole range (every page of the request log, not only this one)."}}}]}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/watches":{"post":{"operationId":"createWatch","tags":["Monitoring"],"summary":"Watch a case by CNR, or a party by name","x-aos-price":"15 credits a case-month (1,000+: 10, 10,000+: 6); party: 30 credits a entity-month (1,000+: 20, 10,000+: 12)","description":"Charged for the month it is created in, then on the 1st of each month while active. A party watch is name monitoring: the account must have paid once. Events: case.updated, case.next_date_changed, case.disposed, order.published, causelist.listed (case watches), party.new_case (party watches).","parameters":[{"$ref":"#\/components\/parameters\/IdempotencyKey"},{"$ref":"#\/components\/parameters\/SandboxDate"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["case","party"]},"cnr":{"type":"string","description":"kind=case: a 16-character CNR (test keys: a sandbox CNR)."},"name":{"type":"string","minLength":3,"description":"kind=party: the person or company name."},"state":{"type":"string","description":"kind=party: narrow to a state."}}}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Watch"}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"402":{"$ref":"#\/components\/responses\/PaymentRequired"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"},"409":{"$ref":"#\/components\/responses\/Conflict"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"},"503":{"$ref":"#\/components\/responses\/UpstreamUnavailable"}}},"get":{"operationId":"listWatches","tags":["Monitoring"],"summary":"Your watches, newest first","x-aos-price":"free","parameters":[{"name":"kind","in":"query","schema":{"type":"string","enum":["case","party"]}},{"name":"status","in":"query","schema":{"type":"string","enum":["active","cancelled","all"],"default":"active"}},{"$ref":"#\/components\/parameters\/Limit"},{"$ref":"#\/components\/parameters\/Cursor"},{"$ref":"#\/components\/parameters\/SandboxDate"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/List"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/Watch"}}}}]}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/watches\/{id}":{"get":{"operationId":"getWatch","tags":["Monitoring"],"summary":"One watch","x-aos-price":"free","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^wch_[0-9]+$"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Watch"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}},"delete":{"operationId":"deleteWatch","tags":["Monitoring"],"summary":"Stop watching (no refund of the current month)","x-aos-price":"free","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^wch_[0-9]+$"}}],"responses":{"200":{"description":"The cancelled watch","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Watch"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/webhook-endpoints":{"post":{"operationId":"createWebhookEndpoint","tags":["Webhooks"],"summary":"Add an endpoint; the signing secret is shown once","x-aos-price":"free","description":"The URL must be https and public (private, loopback and link-local addresses are refused, now and at every delivery). Each delivery is a POST of {id, object: \"event\", type, created_at, data, mode} with the headers AOS-Event-Id and AOS-Signature: t={unix},v1={hex HMAC-SHA256(secret, \"{t}.{body}\")}. A non-2xx answer or no answer within 10 s is retried after 1 m, 5 m, 30 m, 2 h, 6 h and 24 h; three days of failures disable the endpoint. For local development use the CLI listen command, which polls GET \/events.","parameters":[{"$ref":"#\/components\/parameters\/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri","maxLength":500,"pattern":"^https:\/\/"},"events":{"description":"\"*\" (default) or a list of event types.","oneOf":[{"type":"string","const":"*"},{"type":"array","items":{"type":"string","enum":["case.updated","case.next_date_changed","case.disposed","order.published","causelist.listed","party.new_case","report.completed","report.failed","job.completed","job.failed","webhook.test","board.item_called","*"]}}]},"description":{"type":"string","maxLength":200}}}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/WebhookEndpoint"},{"type":"object","properties":{"secret":{"type":"string","description":"whsec_\u2026 shown only here."}}}]}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"409":{"$ref":"#\/components\/responses\/Conflict"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}},"get":{"operationId":"listWebhookEndpoints","tags":["Webhooks"],"summary":"Your endpoints in this mode","x-aos-price":"free","parameters":[{"$ref":"#\/components\/parameters\/Limit"},{"$ref":"#\/components\/parameters\/Cursor"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/List"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/WebhookEndpoint"}}}}]}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/webhook-endpoints\/{id}":{"get":{"operationId":"getWebhookEndpoint","tags":["Webhooks"],"summary":"One endpoint with its recent deliveries","x-aos-price":"free","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^whe_[0-9]+$"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/WebhookEndpoint"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}},"delete":{"operationId":"deleteWebhookEndpoint","tags":["Webhooks"],"summary":"Remove an endpoint and its pending deliveries","x-aos-price":"free","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^whe_[0-9]+$"}}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"webhook_endpoint"},"id":{"type":"string"},"deleted":{"type":"boolean"}}}}}},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/webhook-endpoints\/{id}\/test":{"post":{"operationId":"testWebhookEndpoint","tags":["Webhooks"],"summary":"Send a signed webhook.test event now","x-aos-price":"free","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^whe_[0-9]+$"}}],"description":"A disabled endpoint that answers 2xx is switched back on.","responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/WebhookTest"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/workspace\/deadlines":{"get":{"operationId":"listWorkspaceDeadlines","tags":["Workspace"],"summary":"Deadlines (limitation, filing, compliance)","description":"Acts as the member (an API key acts as the firm owner) and sees only what the member sees in the app; clients who have not agreed to AI are left out. Test keys use the firm's own workspace, free (AOS-Mode: test); what they write says \"(test)\".","x-aos-price":"0.02 credits a call; the first 1,00,000 calls a month (reads and writes together) are free","security":[{"bearer":[]},{"oauth2":["mcp:read"]}],"parameters":[{"name":"to","in":"query","schema":{"type":"string","format":"date"},"description":"Last day. Default 60 days ahead; overdue are included."},{"name":"matter_id","in":"query","schema":{"type":"integer"},"description":"Only this matter."},{"name":"include_done","in":"query","schema":{"type":"boolean"},"description":"Also met deadlines."},{"$ref":"#\/components\/parameters\/Limit"},{"$ref":"#\/components\/parameters\/Cursor"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/List"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/WorkspaceDeadline"}}}}]}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/workspace\/documents":{"get":{"operationId":"searchWorkspaceDocuments","tags":["Workspace"],"summary":"Search the record","description":"Each document lists its matching pages under `matches`, with a pin (D12p4 = document 12, page 4) to cite. Acts as the member (an API key acts as the firm owner) and sees only what the member sees in the app; clients who have not agreed to AI are left out. Test keys use the firm's own workspace, free (AOS-Mode: test); what they write says \"(test)\".","x-aos-price":"0.02 credits a call; the first 1,00,000 calls a month (reads and writes together) are free","security":[{"bearer":[]},{"oauth2":["mcp:read"]}],"parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","maxLength":300},"description":"Words to find in document names and read pages."},{"name":"matter_id","in":"query","schema":{"type":"integer"},"description":"Only this matter."},{"$ref":"#\/components\/parameters\/Limit"},{"$ref":"#\/components\/parameters\/Cursor"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/List"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/WorkspaceDocument"}}}}]}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/workspace\/documents\/{id}\/text":{"get":{"operationId":"getWorkspaceDocumentText","tags":["Workspace"],"summary":"Read document pages","description":"Acts as the member (an API key acts as the firm owner) and sees only what the member sees in the app; clients who have not agreed to AI are left out. Test keys use the firm's own workspace, free (AOS-Mode: test); what they write says \"(test)\".","x-aos-price":"0.02 credits a call; the first 1,00,000 calls a month (reads and writes together) are free","security":[{"bearer":[]},{"oauth2":["mcp:read"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"},"description":"The document id."},{"name":"from_page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"name":"to_page","in":"query","schema":{"type":"integer","minimum":1},"description":"Default from_page + 9; at most 20 pages and 60,000 characters a call (follow next_page)."}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/WorkspaceDocumentText"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/workspace\/drafts":{"get":{"operationId":"listWorkspaceDrafts","tags":["Workspace"],"summary":"The firm's drafts, newest first","description":"Cursor paging reaches the first 50 drafts. Acts as the member (an API key acts as the firm owner) and sees only what the member sees in the app; clients who have not agreed to AI are left out. Test keys use the firm's own workspace, free (AOS-Mode: test); what they write says \"(test)\".","x-aos-price":"0.02 credits a call; the first 1,00,000 calls a month (reads and writes together) are free","security":[{"bearer":[]},{"oauth2":["mcp:read"]}],"parameters":[{"name":"matter_id","in":"query","schema":{"type":"integer"},"description":"Only this matter."},{"$ref":"#\/components\/parameters\/Limit"},{"$ref":"#\/components\/parameters\/Cursor"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/List"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/WorkspaceDraft"}}}}]}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/workspace\/hearings":{"get":{"operationId":"listWorkspaceHearings","tags":["Workspace"],"summary":"Hearings between two dates","description":"At most 200 hearings in the range. Acts as the member (an API key acts as the firm owner) and sees only what the member sees in the app; clients who have not agreed to AI are left out. Test keys use the firm's own workspace, free (AOS-Mode: test); what they write says \"(test)\".","x-aos-price":"0.02 credits a call; the first 1,00,000 calls a month (reads and writes together) are free","security":[{"bearer":[]},{"oauth2":["mcp:read"]}],"parameters":[{"name":"from","in":"query","schema":{"type":"string","format":"date"},"description":"First day (IST). Default today."},{"name":"to","in":"query","schema":{"type":"string","format":"date"},"description":"Last day. Default from + 14 days."},{"name":"matter_id","in":"query","schema":{"type":"integer"},"description":"Only this matter."},{"$ref":"#\/components\/parameters\/Limit"},{"$ref":"#\/components\/parameters\/Cursor"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/List"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/WorkspaceHearing"}}}}]}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/workspace\/matters":{"get":{"operationId":"listWorkspaceMatters","tags":["Workspace"],"summary":"Search the firm's matters","description":"Cursor paging reaches the first 50 matters of a search; narrow with q beyond that. Acts as the member (an API key acts as the firm owner) and sees only what the member sees in the app; clients who have not agreed to AI are left out. Test keys use the firm's own workspace, free (AOS-Mode: test); what they write says \"(test)\".","x-aos-price":"0.02 credits a call; the first 1,00,000 calls a month (reads and writes together) are free","security":[{"bearer":[]},{"oauth2":["mcp:read"]}],"parameters":[{"name":"q","in":"query","schema":{"type":"string","maxLength":200},"description":"Title, number, CNR, client or opposite party; leave out for the latest."},{"name":"status","in":"query","schema":{"type":"string","enum":["open","closed","all"],"default":"open"}},{"$ref":"#\/components\/parameters\/Limit"},{"$ref":"#\/components\/parameters\/Cursor"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/List"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/WorkspaceMatter"}}}}]}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/workspace\/matters\/{id}":{"get":{"operationId":"getWorkspaceMatter","tags":["Workspace"],"summary":"One matter with its parties, open deadlines and latest timeline","description":"Acts as the member (an API key acts as the firm owner) and sees only what the member sees in the app; clients who have not agreed to AI are left out. Test keys use the firm's own workspace, free (AOS-Mode: test); what they write says \"(test)\".","x-aos-price":"0.02 credits a call; the first 1,00,000 calls a month (reads and writes together) are free","security":[{"bearer":[]},{"oauth2":["mcp:read"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"},"description":"The matter id."}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/WorkspaceMatterDetail"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/workspace\/notes":{"post":{"operationId":"createWorkspaceNote","tags":["Workspace"],"summary":"Add a note to a matter","description":"Needs workspace:write on a key, or an OAuth token that was allowed to write, and the member's own permission to create notes. It shows on the matter's timeline. Acts as the member (an API key acts as the firm owner) and sees only what the member sees in the app; clients who have not agreed to AI are left out. Test keys use the firm's own workspace, free (AOS-Mode: test); what they write says \"(test)\".","x-aos-price":"0.10 credits a call; the first 1,00,000 calls a month (reads and writes together) are free","security":[{"bearer":[]},{"oauth2":["mcp:read","mcp:write"]}],"parameters":[{"$ref":"#\/components\/parameters\/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/WorkspaceNoteInput"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/WorkspaceNote"}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"402":{"$ref":"#\/components\/responses\/PaymentRequired"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}},"\/workspace\/tasks":{"get":{"operationId":"listWorkspaceTasks","tags":["Workspace"],"summary":"Open tasks","description":"Acts as the member (an API key acts as the firm owner) and sees only what the member sees in the app; clients who have not agreed to AI are left out. Test keys use the firm's own workspace, free (AOS-Mode: test); what they write says \"(test)\".","x-aos-price":"0.02 credits a call; the first 1,00,000 calls a month (reads and writes together) are free","security":[{"bearer":[]},{"oauth2":["mcp:read"]}],"parameters":[{"name":"matter_id","in":"query","schema":{"type":"integer"},"description":"Only this matter."},{"name":"mine","in":"query","schema":{"type":"boolean"},"description":"Only tasks assigned to the member."},{"name":"include_done","in":"query","schema":{"type":"boolean"},"description":"Also completed tasks."},{"$ref":"#\/components\/parameters\/Limit"},{"$ref":"#\/components\/parameters\/Cursor"}],"responses":{"200":{"description":"OK","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/List"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/WorkspaceTask"}}}}]}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}},"post":{"operationId":"createWorkspaceTask","tags":["Workspace"],"summary":"Add a task for the member","description":"Needs workspace:write on a key, or an OAuth token that was allowed to write, and the member's own permission to create tasks. With a matter, the task shows on its timeline. Acts as the member (an API key acts as the firm owner) and sees only what the member sees in the app; clients who have not agreed to AI are left out. Test keys use the firm's own workspace, free (AOS-Mode: test); what they write says \"(test)\".","x-aos-price":"0.10 credits a call; the first 1,00,000 calls a month (reads and writes together) are free","security":[{"bearer":[]},{"oauth2":["mcp:read","mcp:write"]}],"parameters":[{"$ref":"#\/components\/parameters\/IdempotencyKey"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/WorkspaceTaskInput"}}}},"responses":{"201":{"description":"Created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/WorkspaceTask"}}}},"400":{"$ref":"#\/components\/responses\/InvalidRequest"},"401":{"$ref":"#\/components\/responses\/Unauthorized"},"402":{"$ref":"#\/components\/responses\/PaymentRequired"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"404":{"$ref":"#\/components\/responses\/NotFound"},"429":{"$ref":"#\/components\/responses\/RateLimited"},"500":{"$ref":"#\/components\/responses\/ServerError"}}}}},"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"An API key: aos_test_\u2026 reads the Sandbox High Court for free; aos_live_\u2026 reads real courts and is billed."},"oauth2":{"type":"oauth2","description":"The connector's sign-in, for workspace endpoints only: authorization code with PKCE (S256). mcp:read reads; mcp:write also creates tasks and notes. Dynamic client registration: POST \/oauth\/register.","flows":{"authorizationCode":{"authorizationUrl":"https:\/\/adv.heliosynctech.com\/oauth\/authorize","tokenUrl":"https:\/\/adv.heliosynctech.com\/oauth\/token","refreshUrl":"https:\/\/adv.heliosynctech.com\/oauth\/token","scopes":{"mcp:read":"Read matters, hearings, deadlines, tasks, the record and drafts the member sees.","mcp:write":"Also add tasks and notes."}}}}},"schemas":{"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["type","code","message","doc_url","request_id"],"properties":{"type":{"type":"string","enum":["invalid_request","authentication","insufficient_credits","permission","not_found","conflict","rate_limited","server_error","upstream_unavailable"]},"code":{"type":"string","description":"Stable machine code; its page is doc_url."},"message":{"type":"string","description":"What went wrong and the fix."},"param":{"type":"string","description":"The parameter or header at fault."},"doc_url":{"type":"string","format":"uri"},"request_id":{"type":"string","pattern":"^req_[A-Za-z0-9]{24}$"}}}}},"List":{"type":"object","required":["object","data","has_more","next_cursor"],"properties":{"object":{"type":"string","const":"list"},"data":{"type":"array","items":{}},"has_more":{"type":"boolean"},"next_cursor":{"type":["string","null"]}}},"Account":{"type":"object","properties":{"object":{"type":"string","const":"account"},"id":{"type":"string"},"name":{"type":"string"},"mode":{"type":"string","enum":["test","live"]},"version":{"type":"string"},"plan":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"credits":{"type":"number"},"renews_at":{"type":["string","null"],"format":"date"}}},"tier":{"type":"string","enum":["T0","T1","T2","T3"]},"discount_pct":{"type":"number"},"postpaid_limit":{"type":"number"},"limits":{"type":"object","properties":{"requests_per_second":{"type":"integer"},"daily_spend":{"type":"number"},"spent_today":{"type":"number"}}},"credits":{"type":"object","properties":{"allowance":{"type":"number"},"allowance_used":{"type":"number"},"allowance_left":{"type":"number"},"wallet":{"type":"number"},"available":{"type":"number"},"grants":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"credits":{"type":"number"},"remaining":{"type":"number"},"expires_at":{"type":["string","null"],"format":"date-time"}}}}}},"key":{"type":["object","null"],"properties":{"name":{"type":"string"},"mode":{"type":"string"},"hint":{"type":"string"},"scopes":{"type":"array","items":{"type":"string"}}}}}},"Usage":{"type":"object","properties":{"object":{"type":"string","const":"usage"},"endpoint":{"type":"string"},"day":{"type":"string","format":"date"},"requests":{"type":"integer"},"billed":{"type":"integer"},"units":{"type":"number"},"credits":{"type":"number"}}},"UsageRequest":{"type":"object","properties":{"object":{"type":"string","const":"request"},"request_id":{"type":"string"},"endpoint":{"type":"string"},"http_status":{"type":"integer"},"credits":{"type":"number"},"created_at":{"type":"string","format":"date-time"}}},"Case":{"type":"object","description":"A court case. Party names of a protected category are masked.","properties":{"object":{"type":"string","const":"case"},"cnr":{"type":"string"},"court":{"type":"string","description":"district | high | sc; sandbox: SBHC-P, SBHC-N, SBHC-S."},"court_name":{"type":["string","null"]},"court_no":{"type":["string","null"]},"case_type":{"type":["string","null"]},"case_type_name":{"type":["string","null"]},"registration_number":{"type":["string","null"]},"filing_date":{"type":["string","null"],"format":"date"},"petitioner":{"type":["string","null"]},"respondent":{"type":["string","null"]},"petitioner_advocate":{"type":["string","null"]},"respondent_advocate":{"type":["string","null"]},"judge":{"type":["string","null"]},"stage":{"type":["string","null"]},"status":{"type":"string","enum":["pending","disposed"]},"next_hearing_date":{"type":["string","null"],"format":"date"},"decision_date":{"type":["string","null"],"format":"date"},"protected":{"type":"boolean"},"acts":{"type":"array","items":{"type":"object","properties":{"act":{"type":"string"},"short":{"type":["string","null"]},"sections":{"type":"array","items":{"type":"string"}}}}},"fetched_at":{"type":["string","null"],"format":"date-time"},"cached":{"type":"boolean"},"stale":{"type":"boolean"},"sandbox":{"type":"boolean"},"orders":{"type":"array","items":{"$ref":"#\/components\/schemas\/Order"},"description":"Newest first, at most 30; absent in search results."}}},"Order":{"type":"object","properties":{"object":{"type":"string","const":"order"},"id":{"type":"string"},"cnr":{"type":"string"},"kind":{"type":"string"},"no":{"type":["string","null"]},"date":{"type":["string","null"],"format":"date"},"title":{"type":["string","null"]},"has_text":{"type":"boolean"},"has_pdf":{"type":"boolean"},"pages":{"type":["integer","null"]},"protected":{"type":"boolean"},"sandbox":{"type":"boolean"}}},"OrderText":{"type":"object","properties":{"object":{"type":"string","const":"order"},"id":{"type":"string"},"cnr":{"type":"string"},"kind":{"type":"string"},"no":{"type":["string","null"]},"date":{"type":["string","null"],"format":"date"},"title":{"type":["string","null"]},"has_text":{"type":"boolean"},"has_pdf":{"type":"boolean"},"pages":{"type":["integer","null"]},"protected":{"type":"boolean"},"sandbox":{"type":"boolean"},"text":{"type":["string","null"]},"withheld":{"type":"boolean"}}},"CauseList":{"type":"object","properties":{"object":{"type":"string","const":"cause_list"},"id":{"type":"string"},"court":{"type":"string"},"court_name":{"type":"string"},"date":{"type":"string","format":"date"},"title":{"type":["string","null"]},"entry_count":{"type":"integer"},"entries_truncated":{"type":"boolean"},"entries":{"type":"array","items":{"$ref":"#\/components\/schemas\/CauseListEntry"}},"sandbox":{"type":"boolean"}}},"CauseListEntry":{"type":"object","properties":{"object":{"type":"string","const":"cause_list_entry"},"item":{"type":["string","null"]},"cnr":{"type":["string","null"]},"case_number":{"type":["string","null"]},"court":{"type":"string"},"court_no":{"type":["string","null"]},"bench":{"type":["string","null"]},"section":{"type":["string","null"]},"petitioner":{"type":["string","null"]},"respondent":{"type":["string","null"]},"parties":{"type":"string"},"advocates":{"type":["string","null"]},"stage":{"type":["string","null"]},"protected":{"type":"boolean"}}},"CauseListMatch":{"type":"object","properties":{"object":{"type":"string","const":"cause_list_match"},"cnr":{"type":"string"},"date":{"type":"string","format":"date"},"listed":{"type":"boolean"},"entry":{"oneOf":[{"$ref":"#\/components\/schemas\/CauseListEntry"},{"type":"null"}]}}},"TribunalOrder":{"type":"object","properties":{"object":{"type":"string","const":"tribunal_order"},"id":{"type":"integer"},"forum":{"type":["string","null"]},"court_name":{"type":["string","null"]},"title":{"type":"string"},"case_no":{"type":["string","null"]},"cnr":{"type":["string","null"]},"bench":{"type":["string","null"]},"decision_date":{"type":["string","null"],"format":"date"},"disposal":{"type":["string","null"]},"pages":{"type":["integer","null"]},"snippet":{"type":"string"}}},"TribunalOrderText":{"type":"object","properties":{"object":{"type":"string","const":"tribunal_order"},"id":{"type":"integer"},"forum":{"type":["string","null"]},"court_name":{"type":["string","null"]},"title":{"type":"string"},"case_no":{"type":["string","null"]},"cnr":{"type":["string","null"]},"bench":{"type":["string","null"]},"decision_date":{"type":["string","null"],"format":"date"},"disposal":{"type":["string","null"]},"pages":{"type":["integer","null"]},"text":{"type":["string","null"]},"paragraphs":{"type":"array","items":{"$ref":"#\/components\/schemas\/Paragraph"}},"next_from":{"type":["integer","null"]}}},"CourtFee":{"type":"object","properties":{"object":{"type":"string","const":"court_fee"},"state":{"type":"string"},"value":{"type":"number"},"fee":{"type":"number"},"currency":{"type":"string"},"act":{"type":"string"},"article":{"type":"string"},"as_amended":{"type":"string"},"working":{"type":"string"},"fixed_fees":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"fee":{"type":"number"},"provision":{"type":"string"}}}}}},"CourtInfo":{"type":"object","properties":{"object":{"type":"string","const":"court"},"id":{"type":"string"},"name":{"type":"string"},"level":{"type":"string","enum":["supreme","high","tribunal"]},"state":{"type":["string","null"]},"holiday_key":{"type":["string","null"]},"pack":{"type":["string","null"]},"cause_lists":{"type":"boolean"},"sandbox":{"type":"boolean"}}},"CaseType":{"type":"object","properties":{"object":{"type":"string","const":"case_type"},"code":{"type":"string"},"name":{"type":["string","null"]},"cases":{"type":"integer"},"sandbox":{"type":"boolean"}}},"Holiday":{"type":"object","properties":{"object":{"type":"string","const":"holiday"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"name":{"type":"string"},"court":{"type":"string"}}},"Paragraph":{"type":"object","properties":{"position":{"type":"integer"},"label":{"type":"string","description":"Cite this: \"Para 12\", or \"Passage 7\" when the judgment does not number its paragraphs."},"text":{"type":"string"}}},"Ocr":{"type":"object","properties":{"object":{"type":"string","const":"ocr"},"sandbox":{"type":"boolean","description":"Test keys: a fixed sample, no AI."},"pages":{"type":"array","items":{"type":"object","properties":{"page":{"type":"integer"},"text":{"type":"string"},"legibility":{"type":"string"},"notes":{"type":"array","items":{"type":"string"}}}}}}},"RecordDocument":{"type":"object","properties":{"object":{"type":"string","const":"record_document"},"document":{"type":"string","description":"D1, D2 \u2026 in upload order"},"name":{"type":"string"},"pages":{"type":"integer"},"card":{"type":["object","null"],"description":"kind, date, from, to, ref_no, subject, summary, asks, decides"},"facts":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"actor":{"type":"string"},"date":{"type":"string"},"amount":{"type":"string"},"clause":{"type":"string"},"text":{"type":"string"},"quote":{"type":"string","description":"Kept only when code found it on the cited page."},"flags":{"type":"array","items":{"type":"string"}},"pages":{"type":"array","items":{"type":"object","properties":{"ref":{"type":"string"},"page":{"type":"integer"}}}}}}}}},"Record":{"type":"object","properties":{"object":{"type":"string","const":"record"},"sandbox":{"type":"boolean","description":"Test keys: a fixed sample, no AI."},"documents":{"type":"array","items":{"$ref":"#\/components\/schemas\/RecordDocument"}}}},"RecordDigest":{"type":"object","properties":{"object":{"type":"string","const":"record_digest"},"sandbox":{"type":"boolean","description":"Test keys: a fixed sample, no AI."},"documents":{"type":"array","items":{"$ref":"#\/components\/schemas\/RecordDocument"}},"cards":{"type":"object","additionalProperties":{"type":"string"},"description":"C1 \u2192 D1: the cards the digest cites."},"digest":{"type":"string","description":"Markdown citing cards as [C1]."},"parties":{"type":"array","items":{"type":"object"}},"threads":{"type":"array","items":{"type":"object"}}}},"Translation":{"type":"object","properties":{"object":{"type":"string","const":"translation"},"sandbox":{"type":"boolean","description":"Test keys: a fixed sample, no AI."},"to":{"type":"string"},"notes":{"type":"array","items":{"type":"string"}},"pages":{"type":"array","items":{"type":"object","properties":{"page":{"type":"integer"},"source_language":{"type":"string"},"text":{"type":"string"},"missing":{"type":"boolean"}}}}}},"ResearchAnswer":{"type":"object","properties":{"object":{"type":"string","const":"research_answer"},"sandbox":{"type":"boolean","description":"Test keys: a fixed sample, no AI."},"question":{"type":"string"},"answer":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"sources":{"type":"array","items":{"type":"string"},"description":"Keys of sources: P1 \u2026 (paragraphs), S1 \u2026 (sections)."},"unverified":{"type":"array","items":{"type":"string"},"description":"Citations in the text no source carries."}}}},"unanswerable":{"type":"boolean"},"notes":{"type":"array","items":{"type":"string"}}}},"sources":{"type":"object","additionalProperties":{"type":"object","properties":{"type":{"type":"string","enum":["paragraph","section"]},"judgment_id":{"type":"integer"},"paragraph_id":{"type":"integer"},"label":{"type":"string","description":"The paragraph label, e.g. Para 12"},"title":{"type":"string"},"citation":{"type":"string"},"court":{"type":"string"},"date":{"type":"string"},"act_id":{"type":"integer"},"number":{"type":"string"},"text":{"type":"string"}}}}}},"Blueprint":{"type":"object","properties":{"object":{"type":"string","const":"blueprint"},"key":{"type":"string"},"name":{"type":"string"},"group":{"type":"string"},"kind":{"type":"string"},"summary":{"type":"string"},"ai":{"type":"boolean"},"sides":{"type":"array","items":{"type":"string"}},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"type":{"type":"string"},"required":{"type":"boolean"},"help":{"type":"string"}}}}}},"Party":{"type":"object","required":["name"],"properties":{"name":{"type":"string","maxLength":300},"details":{"type":"string","maxLength":2000}}},"Draft":{"type":"object","properties":{"object":{"type":"string","const":"draft"},"sandbox":{"type":"boolean","description":"Test keys: a fixed sample, no AI."},"id":{"type":["integer","string"]},"blueprint":{"type":"string"},"title":{"type":"string"},"language":{"type":"string"},"status":{"type":"string"},"html":{"type":"string"},"warnings":{"type":"array","items":{"type":"object"}}}},"OrderSummary":{"type":"object","properties":{"object":{"type":"string","const":"order_summary"},"sandbox":{"type":"boolean","description":"Test keys: a fixed sample, no AI."},"order_id":{"type":["integer","string"]},"reused":{"type":"boolean","description":"The stored summary was returned; no AI ran."},"summary":{"type":"array","items":{"type":"string"}},"outcome":{"type":"string"},"next_date":{"type":["string","null"],"format":"date"},"next_purpose":{"type":"string"},"directions":{"type":"array","items":{"type":"object","properties":{"who":{"type":"string"},"what":{"type":"string"},"due_date":{"type":["string","null"]},"due_text":{"type":"string"}}}},"coram":{"type":"string"},"language":{"type":"string"},"notes":{"type":"array","items":{"type":"string"}},"digested_at":{"type":["string","null"],"format":"date-time"}}},"Job":{"type":"object","required":["object","id","kind","status","pages","created_at"],"properties":{"object":{"type":"string","const":"job"},"id":{"type":"string","pattern":"^job_[A-Za-z0-9]{24}$"},"kind":{"type":"string","enum":["ocr","record_read","record_digest","translation"]},"status":{"type":"string","enum":["queued","processing","completed","failed"]},"pages":{"type":"integer","description":"Pages in the files; once completed, the pages processed (the units charged)."},"batch":{"type":"boolean"},"credits":{"type":"number","description":"Charged on completion."},"created_at":{"type":"string","format":"date-time"},"completed_at":{"type":["string","null"],"format":"date-time"},"result":{"description":"When completed: the same object a small call answers with.","oneOf":[{"$ref":"#\/components\/schemas\/Ocr"},{"$ref":"#\/components\/schemas\/Record"},{"$ref":"#\/components\/schemas\/RecordDigest"},{"$ref":"#\/components\/schemas\/Translation"}]},"error":{"type":"object","properties":{"message":{"type":"string"}}},"sandbox":{"type":"boolean"}}},"ActSection":{"type":"object","properties":{"object":{"type":"string","const":"act_section"},"act":{"type":"object","properties":{"id":{"type":"integer"},"short_name":{"type":["string","null"]},"title":{"type":"string"},"year":{"type":["integer","null"]},"jurisdiction":{"type":"string"},"state":{"type":["string","null"]},"in_force":{"type":"boolean"}}},"number":{"type":"string"},"title":{"type":["string","null"]},"chapter":{"type":["string","null"]},"text":{"type":"string"},"amended_at":{"type":["string","null"],"format":"date"},"source_url":{"type":["string","null"]},"counterpart":{"type":["object","null"],"properties":{"act":{"type":"string"},"section":{"type":"string"},"sure":{"type":"boolean","description":"false: from the imported mapping; check the bare act."}}}}},"CodeMap":{"type":"object","properties":{"object":{"type":"string","const":"code_map"},"act":{"type":"string"},"section":{"type":"string"},"counterpart":{"type":["object","null"],"properties":{"act":{"type":"string"},"section":{"type":"string"},"sure":{"type":"boolean","description":"false: from the imported mapping; check the bare act."}}},"direction":{"type":"string","enum":["old_to_new","new_to_old"]},"write_as":{"type":"string","example":"s.318(4) BNS (s.420 IPC)"},"effective_from":{"type":"string","format":"date"},"note":{"type":"string"}}},"LimitationRule":{"type":"object","properties":{"object":{"type":"string","const":"limitation_rule"},"key":{"type":"string"},"name":{"type":"string"},"basis":{"type":"string"},"group":{"type":"string"},"group_label":{"type":"string"},"from":{"type":"string"},"period":{"type":"string"},"copies_excluded":{"type":"boolean"},"court_filing":{"type":"boolean"},"note":{"type":["string","null"]}}},"Limitation":{"type":"object","properties":{"object":{"type":"string","const":"limitation"},"rule":{"type":"string"},"name":{"type":"string"},"basis":{"type":"string"},"from":{"type":"string"},"start":{"type":"string","format":"date"},"raw_due":{"type":"string","format":"date"},"due":{"type":"string","format":"date"},"steps":{"type":"array","items":{"type":"string"}},"note":{"type":["string","null"]},"excluded_days":{"type":"integer"},"court":{"type":["string","null"]}}},"ReportRequest":{"type":"object","required":["type","subject"],"properties":{"type":{"type":"string","enum":["litigation_check","due_diligence"]},"subject":{"type":"object","required":["kind","name"],"properties":{"kind":{"type":"string","enum":["person","company"]},"name":{"type":"string","minLength":3,"maxLength":200},"father_name":{"type":"string","description":"Persons: narrows a common name (a record naming a different father is ruled out)."},"cin":{"type":"string","description":"Companies: the 21-character CIN, confirms a match when it appears in the record."},"state":{"type":"string"},"district":{"type":"string"},"entities":{"type":"array","maxItems":25,"description":"due_diligence only: group entities, promoters and directors, each checked like the subject.","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"kind":{"type":"string","enum":["person","company"]},"relation":{"type":"string","enum":["group_entity","promoter","director"],"default":"group_entity"},"father_name":{"type":"string"},"cin":{"type":"string"}}}}}}}},"Report":{"type":"object","properties":{"object":{"type":"string","const":"report"},"id":{"type":"string"},"type":{"type":"string","enum":["litigation_check","due_diligence"]},"status":{"type":"string","enum":["queued","running","completed","failed"]},"livemode":{"type":"boolean"},"subject":{"type":"object","required":["kind","name"],"properties":{"kind":{"type":"string","enum":["person","company"]},"name":{"type":"string","minLength":3,"maxLength":200},"father_name":{"type":"string","description":"Persons: narrows a common name (a record naming a different father is ruled out)."},"cin":{"type":"string","description":"Companies: the 21-character CIN, confirms a match when it appears in the record."},"state":{"type":"string"},"district":{"type":"string"},"entities":{"type":"array","maxItems":25,"description":"due_diligence only: group entities, promoters and directors, each checked like the subject.","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"kind":{"type":"string","enum":["person","company"]},"relation":{"type":"string","enum":["group_entity","promoter","director"],"default":"group_entity"},"father_name":{"type":"string"},"cin":{"type":"string"}}}}}},"created_at":{"type":"string","format":"date-time"},"completed_at":{"type":["string","null"],"format":"date-time"},"summary":{"$ref":"#\/components\/schemas\/ReportSummary"},"entities":{"type":"array","description":"due_diligence: the counts for each name checked.","items":{"type":"object","properties":{"name":{"type":"string"},"kind":{"type":"string"},"relation":{"type":"string"},"cases_found":{"type":"integer"},"possible_matches":{"type":"integer"},"by_risk":{"type":"object","properties":{"protected":{"type":"integer"},"ibc":{"type":"integer"},"sarfaesi":{"type":"integer"},"drt":{"type":"integer"},"cheque_bounce":{"type":"integer"},"criminal":{"type":"integer"},"consumer":{"type":"integer"},"recovery":{"type":"integer"},"other":{"type":"integer"}}}}}},"hits":{"type":"array","description":"When completed (GET \/reports\/{id} only).","items":{"$ref":"#\/components\/schemas\/ReportHit"}},"pdf_url":{"type":["string","null"],"format":"uri","description":"Absolute; fetch it with your key. Null until completed, and when the PDF could not be laid out (see note)."},"verify_url":{"type":["string","null"],"format":"uri","description":"The public page the PDF's QR opens: shows only that the file is genuine."},"note":{"type":["string","null"]},"error":{"type":["object","null"],"properties":{"message":{"type":"string"}}}}},"ReportSummary":{"type":"object","properties":{"cases_found":{"type":"integer"},"possible_matches":{"type":"integer","description":"How many hits are low confidence."},"by_risk":{"type":"object","properties":{"protected":{"type":"integer"},"ibc":{"type":"integer"},"sarfaesi":{"type":"integer"},"drt":{"type":"integer"},"cheque_bounce":{"type":"integer"},"criminal":{"type":"integer"},"consumer":{"type":"integer"},"recovery":{"type":"integer"},"other":{"type":"integer"}},"description":"Cases by the most serious flag each carries: protected, ibc, sarfaesi, drt, cheque_bounce, criminal, consumer, recovery, other."},"by_confidence":{"type":"object","properties":{"high":{"type":"integer"},"medium":{"type":"integer"},"low":{"type":"integer"}}},"forums_checked":{"type":"array","items":{"type":"string","enum":["district_court","high_court","supreme_court","tribunal","cause_list","sandbox_high_court"]}},"truncated":{"type":"boolean","description":"True when a very common name matched more records than were read; add a father's name, CIN, state or district."},"checked_at":{"type":"string","format":"date-time"}}},"ReportHit":{"type":"object","properties":{"forum":{"type":"string","enum":["district_court","high_court","supreme_court","tribunal","cause_list","sandbox_high_court"]},"court":{"type":"string"},"case_number":{"type":["string","null"]},"cnr":{"type":["string","null"]},"case_type":{"type":["string","null"]},"parties":{"type":"object","properties":{"petitioner":{"type":"string"},"respondent":{"type":"string"}},"description":"Withheld for protected categories."},"role":{"type":"string","enum":["petitioner","respondent"],"description":"The side the subject matched."},"status":{"type":"string","description":"pending, disposed, listed, decided or order."},"next_date":{"type":["string","null"],"format":"date"},"decision_date":{"type":["string","null"],"format":"date"},"last_listed":{"type":["string","null"],"format":"date"},"risk":{"type":"string","enum":["protected","ibc","sarfaesi","drt","cheque_bounce","criminal","consumer","recovery","other"]},"flags":{"type":"array","items":{"type":"string","enum":["protected","ibc","sarfaesi","drt","cheque_bounce","criminal","consumer","recovery","other"]}},"protected":{"type":"boolean"},"source":{"type":"string","enum":["court_cases","cause_list","judgment","tribunal_order","sandbox"]},"source_id":{"type":["integer","null"]},"match":{"type":"object","properties":{"confidence":{"type":"string","enum":["high","medium","low"]},"score":{"type":"integer","minimum":50,"maximum":100},"reasons":{"type":"array","items":{"type":"string"}},"corroborated":{"type":"boolean","description":"Confirmed by the father's name, CIN, state or district."}}},"entity":{"type":"object","description":"Which name this hit is for (due_diligence).","properties":{"name":{"type":"string"},"relation":{"type":"string","enum":["subject","group_entity","promoter","director"]}}}}},"JudgmentHit":{"type":"object","properties":{"object":{"type":"string","const":"judgment"},"id":{"type":"integer"},"court":{"type":"string","enum":["sc","hc","trib"]},"court_name":{"type":["string","null"]},"title":{"type":"string"},"citation":{"type":["string","null"]},"neutral_citation":{"type":["string","null"]},"bench":{"type":["string","null"]},"case_no":{"type":["string","null"]},"cnr":{"type":["string","null"]},"decision_date":{"type":["string","null"],"format":"date"},"disposal":{"type":["string","null"]},"pages":{"type":["integer","null"]},"snippet":{"type":"string"},"citator":{"type":["object","null"],"properties":{"cited_by":{"type":"integer"},"overruled":{"type":"integer"},"distinguished":{"type":"integer"},"followed":{"type":"integer"}}}}},"JudgmentFull":{"type":"object","properties":{"object":{"type":"string","const":"judgment"},"id":{"type":"integer"},"court":{"type":"string","enum":["sc","hc","trib"]},"court_name":{"type":["string","null"]},"title":{"type":"string"},"citation":{"type":["string","null"]},"neutral_citation":{"type":["string","null"]},"bench":{"type":["string","null"]},"case_no":{"type":["string","null"]},"cnr":{"type":["string","null"]},"decision_date":{"type":["string","null"],"format":"date"},"disposal":{"type":["string","null"]},"pages":{"type":["integer","null"]},"text":{"type":["string","null"]},"paragraphs":{"type":"array","items":{"$ref":"#\/components\/schemas\/Paragraph"}},"next_from":{"type":["integer","null"]}}},"Citator":{"type":"object","properties":{"object":{"type":"string","const":"citator"},"judgment":{"type":"object","properties":{"object":{"type":"string","const":"judgment"},"id":{"type":"integer"},"court":{"type":"string","enum":["sc","hc","trib"]},"court_name":{"type":["string","null"]},"title":{"type":"string"},"citation":{"type":["string","null"]},"neutral_citation":{"type":["string","null"]},"bench":{"type":["string","null"]},"case_no":{"type":["string","null"]},"cnr":{"type":["string","null"]},"decision_date":{"type":["string","null"],"format":"date"},"disposal":{"type":["string","null"]},"pages":{"type":["integer","null"]}}},"cited_by":{"type":"integer"},"overruled":{"type":"integer"},"distinguished":{"type":"integer"},"followed":{"type":"integer"},"stayed":{"type":"integer"},"stayed_url":{"type":"string"},"citing":{"allOf":[{"$ref":"#\/components\/schemas\/List"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/CitingJudgment"}}}}]}}},"CitingJudgment":{"type":"object","properties":{"object":{"type":"string","const":"citation"},"cited_as":{"type":"string"},"treatment":{"type":"string","enum":["followed","distinguished","overruled","doubted","referred"]},"read_by":{"type":"string","enum":["code","ai_checked_by_code"]},"quote":{"type":["string","null"]},"paragraph":{"type":["integer","null"]},"judgment":{"type":"object","properties":{"object":{"type":"string","const":"judgment"},"id":{"type":"integer"},"title":{"type":"string"},"court":{"type":"string"},"court_name":{"type":["string","null"]},"citation":{"type":["string","null"]},"decision_date":{"type":["string","null"],"format":"date"}}}}},"CitationCheck":{"type":"object","properties":{"object":{"type":"string","const":"citation_check"},"total":{"type":"integer"},"verified":{"type":"integer"},"mismatch":{"type":"integer"},"unknown":{"type":"integer"},"items":{"type":"array","items":{"type":"object","properties":{"citation":{"type":"string"},"name":{"type":["string","null"]},"status":{"type":"string","enum":["verified","mismatch","unknown"]},"judgment":{"type":["object","null"],"properties":{"object":{"type":"string","const":"judgment"},"id":{"type":"integer"},"title":{"type":"string"},"court":{"type":["string","null"]},"year":{"type":["integer","null"]}}},"overruled":{"type":"integer"},"distinguished":{"type":"integer"}}}}}},"Event":{"type":"object","properties":{"object":{"type":"string","const":"event"},"id":{"type":"string"},"type":{"type":"string","enum":["case.updated","case.next_date_changed","case.disposed","order.published","causelist.listed","party.new_case","report.completed","report.failed","job.completed","job.failed","webhook.test","board.item_called"]},"mode":{"type":"string","enum":["test","live"],"description":"The key mode the event belongs to; webhook deliveries carry the same body."},"created_at":{"type":"string","format":"date-time"},"data":{"type":"object"}}},"Watch":{"type":"object","properties":{"object":{"type":"string","const":"watch"},"id":{"type":"string"},"kind":{"type":"string","enum":["case","party"]},"cnr":{"type":"string"},"name":{"type":"string"},"state":{"type":["string","null"]},"status":{"type":"string","enum":["active","cancelled"]},"livemode":{"type":"boolean"},"charged_month":{"type":["string","null"],"description":"yyyy-mm, the last month billed."},"created_at":{"type":"string","format":"date-time"},"cancelled_at":{"type":["string","null"],"format":"date-time"},"error":{"type":["string","null"],"description":"Why the court record could not be fetched yet (it is retried)."},"deleted":{"type":"boolean","description":"Only on the answer to DELETE."}}},"WebhookEndpoint":{"type":"object","properties":{"object":{"type":"string","const":"webhook_endpoint"},"id":{"type":"string"},"url":{"type":"string"},"events":{"type":"array","items":{"type":"string"}},"description":{"type":["string","null"]},"status":{"type":"string","enum":["active","disabled"]},"livemode":{"type":"boolean"},"failures":{"type":"integer"},"disabled_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":"string","format":"date-time"},"recent_deliveries":{"type":"array","description":"Only on GET \/webhook-endpoints\/{id}.","items":{"type":"object","properties":{"event_id":{"type":"string"},"status":{"type":"string","enum":["pending","ok","failed"]},"attempts":{"type":"integer"},"http_status":{"type":["integer","null"]},"next_attempt_at":{"type":["string","null"],"format":"date-time"},"delivered_at":{"type":["string","null"],"format":"date-time"}}}}}},"WebhookTest":{"type":"object","properties":{"object":{"type":"string","const":"webhook_test"},"endpoint_id":{"type":"string"},"event_id":{"type":"string"},"delivered":{"type":"boolean"},"http_status":{"type":["integer","null"]},"response":{"type":"string"}}},"WorkspaceMatter":{"type":"object","properties":{"object":{"type":"string","const":"matter"},"id":{"type":"integer"},"number":{"type":["string","null"]},"title":{"type":"string"},"client":{"type":["string","null"]},"court":{"type":["string","null"]},"case_number":{"type":["string","null"]},"cnr":{"type":["string","null"]},"stage":{"type":["string","null"]},"next_date":{"type":["string","null"],"format":"date"}},"required":["object","id"]},"WorkspaceMatterDetail":{"type":"object","properties":{"object":{"type":"string","const":"matter"},"id":{"type":"integer"},"number":{"type":["string","null"]},"title":{"type":"string"},"description":{"type":["string","null"]},"client":{"type":["string","null"]},"opposite_party":{"type":["string","null"]},"court":{"type":["string","null"]},"bench":{"type":["string","null"]},"case_number":{"type":["string","null"]},"cnr":{"type":["string","null"]},"case_type":{"type":["string","null"]},"status":{"type":["string","null"]},"stage":{"type":["string","null"]},"filing_date":{"type":["string","null"],"format":"date"},"acts_sections":{"type":["string","null"]},"fir":{"type":["string","null"]},"police_station":{"type":["string","null"]},"next_date":{"type":["string","null"],"format":"date"},"parties":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"role":{"type":["string","null"]},"our_client":{"type":"boolean"},"counsel":{"type":["string","null"]}}}},"open_deadlines":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"due":{"type":["string","null"],"format":"date"},"basis":{"type":["string","null"]}}}},"timeline":{"type":"array","items":{"type":"object","properties":{"date":{"type":["string","null"],"format":"date"},"what":{"type":"string"}}}}},"required":["object","id"]},"WorkspaceHearing":{"type":"object","properties":{"object":{"type":"string","const":"hearing"},"id":{"type":"integer"},"date":{"type":["string","null"],"format":"date"},"time":{"type":["string","null"]},"matter_id":{"type":"integer"},"matter":{"type":["string","null"]},"court":{"type":["string","null"]},"purpose":{"type":["string","null"]},"status":{"type":["string","null"]},"outcome":{"type":["string","null"]},"next_date":{"type":["string","null"],"format":"date"}},"required":["object","id"]},"WorkspaceDeadline":{"type":"object","properties":{"object":{"type":"string","const":"deadline"},"id":{"type":"integer"},"title":{"type":"string"},"due":{"type":["string","null"],"format":"date"},"status":{"type":"string"},"basis":{"type":["string","null"]},"rule":{"type":["string","null"]},"matter_id":{"type":"integer"},"matter":{"type":["string","null"]}},"required":["object","id"]},"WorkspaceTask":{"type":"object","properties":{"object":{"type":"string","const":"task"},"id":{"type":["integer","string"]},"title":{"type":"string"},"due":{"type":["string","null"],"format":"date"},"priority":{"type":["string","null"]},"status":{"type":"string"},"matter_id":{"type":["integer","null"]},"matter":{"type":["string","null"]},"mine":{"type":"boolean"},"sandbox":{"type":"boolean","description":"true on a test key: a dry run, nothing was saved."}},"required":["object","id"]},"WorkspaceDocument":{"type":"object","properties":{"object":{"type":"string","const":"document"},"id":{"type":"integer"},"name":{"type":"string"},"matter_id":{"type":"integer"},"matter":{"type":["string","null"]},"pages":{"type":["integer","null"]},"matches":{"type":"array","items":{"type":"object","properties":{"pin":{"type":"string","examples":["D12p4"]},"page":{"type":"integer"},"text":{"type":"string"}}}}},"required":["object","id"]},"WorkspaceDocumentText":{"type":"object","properties":{"object":{"type":"string","const":"document_text"},"document_id":{"type":"integer"},"name":{"type":"string"},"matter_id":{"type":"integer"},"total_pages":{"type":"integer"},"truncated":{"type":"boolean"},"next_page":{"type":["integer","null"]},"pages":{"type":"array","items":{"type":"object","properties":{"pin":{"type":"string"},"page":{"type":["integer","null"]},"unclear_scan":{"type":"boolean"},"text":{"type":"string"}}}}},"required":["object","document_id"]},"WorkspaceDraft":{"type":"object","properties":{"object":{"type":"string","const":"draft"},"id":{"type":"integer"},"title":{"type":"string"},"type":{"type":["string","null"]},"status":{"type":["string","null"]},"review":{"type":["string","null"]},"matter_id":{"type":["integer","null"]},"matter":{"type":["string","null"]},"updated":{"type":["string","null"],"format":"date"}},"required":["object","id"]},"WorkspaceNote":{"type":"object","properties":{"object":{"type":"string","const":"note"},"id":{"type":["integer","string"]},"matter_id":{"type":"integer"},"title":{"type":"string"},"sandbox":{"type":"boolean","description":"true on a test key: a dry run, nothing was saved."}},"required":["object","id"]},"WorkspaceTaskInput":{"type":"object","required":["title"],"properties":{"title":{"type":"string","maxLength":255},"matter_id":{"type":"integer"},"due_date":{"type":"string","format":"date"},"description":{"type":"string","maxLength":5000},"priority":{"type":"string","enum":["low","medium","high"],"default":"medium"}}},"WorkspaceNoteInput":{"type":"object","required":["matter_id","title","text"],"properties":{"matter_id":{"type":"integer"},"title":{"type":"string","maxLength":200},"text":{"type":"string","maxLength":20000}}}},"parameters":{"Limit":{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},"Cursor":{"name":"cursor","in":"query","schema":{"type":"string"},"description":"next_cursor of the previous page."},"IdempotencyKey":{"name":"Idempotency-Key","in":"header","schema":{"type":"string","maxLength":255},"description":"The same key within 24 hours returns the first answer and is not charged again."},"SandboxDate":{"name":"AOS-Sandbox-Date","in":"header","schema":{"type":"string","format":"date"},"description":"Test keys: the sandbox's today (default today in IST)."}},"headers":{"AOS-Request-Id":{"schema":{"type":"string"},"description":"req_ + 24 characters; quote it when asking for help."},"AOS-Mode":{"schema":{"type":"string","enum":["test","live"]}},"AOS-Credits-Charged":{"schema":{"type":"string"},"description":"Credits this request cost (decimal)."},"RateLimit-Limit":{"schema":{"type":"integer"}},"RateLimit-Remaining":{"schema":{"type":"integer"}},"RateLimit-Reset":{"schema":{"type":"integer"},"description":"Seconds until the window resets."}},"responses":{"InvalidRequest":{"description":"invalid_request: a parameter is missing or wrong (see param).","headers":{"AOS-Request-Id":{"$ref":"#\/components\/headers\/AOS-Request-Id"},"AOS-Mode":{"$ref":"#\/components\/headers\/AOS-Mode"},"AOS-Credits-Charged":{"$ref":"#\/components\/headers\/AOS-Credits-Charged"},"RateLimit-Limit":{"$ref":"#\/components\/headers\/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#\/components\/headers\/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#\/components\/headers\/RateLimit-Reset"}},"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"Unauthorized":{"description":"authentication: no key, or a key that is unknown, revoked or expired.","headers":{"AOS-Request-Id":{"$ref":"#\/components\/headers\/AOS-Request-Id"},"AOS-Mode":{"$ref":"#\/components\/headers\/AOS-Mode"},"AOS-Credits-Charged":{"$ref":"#\/components\/headers\/AOS-Credits-Charged"},"RateLimit-Limit":{"$ref":"#\/components\/headers\/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#\/components\/headers\/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#\/components\/headers\/RateLimit-Reset"}},"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"PaymentRequired":{"description":"insufficient_credits: top up, or the day's spend limit was reached.","headers":{"AOS-Request-Id":{"$ref":"#\/components\/headers\/AOS-Request-Id"},"AOS-Mode":{"$ref":"#\/components\/headers\/AOS-Mode"},"AOS-Credits-Charged":{"$ref":"#\/components\/headers\/AOS-Credits-Charged"},"RateLimit-Limit":{"$ref":"#\/components\/headers\/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#\/components\/headers\/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#\/components\/headers\/RateLimit-Reset"}},"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"Forbidden":{"description":"permission: the key lacks a scope, the account must have paid, or the account is paused.","headers":{"AOS-Request-Id":{"$ref":"#\/components\/headers\/AOS-Request-Id"},"AOS-Mode":{"$ref":"#\/components\/headers\/AOS-Mode"},"AOS-Credits-Charged":{"$ref":"#\/components\/headers\/AOS-Credits-Charged"},"RateLimit-Limit":{"$ref":"#\/components\/headers\/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#\/components\/headers\/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#\/components\/headers\/RateLimit-Reset"}},"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"NotFound":{"description":"not_found","headers":{"AOS-Request-Id":{"$ref":"#\/components\/headers\/AOS-Request-Id"},"AOS-Mode":{"$ref":"#\/components\/headers\/AOS-Mode"},"AOS-Credits-Charged":{"$ref":"#\/components\/headers\/AOS-Credits-Charged"},"RateLimit-Limit":{"$ref":"#\/components\/headers\/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#\/components\/headers\/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#\/components\/headers\/RateLimit-Reset"}},"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"Conflict":{"description":"conflict: e.g. an Idempotency-Key reused for a different request.","headers":{"AOS-Request-Id":{"$ref":"#\/components\/headers\/AOS-Request-Id"},"AOS-Mode":{"$ref":"#\/components\/headers\/AOS-Mode"},"AOS-Credits-Charged":{"$ref":"#\/components\/headers\/AOS-Credits-Charged"},"RateLimit-Limit":{"$ref":"#\/components\/headers\/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#\/components\/headers\/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#\/components\/headers\/RateLimit-Reset"}},"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"RateLimited":{"description":"rate_limited: wait RateLimit-Reset seconds.","headers":{"AOS-Request-Id":{"$ref":"#\/components\/headers\/AOS-Request-Id"},"AOS-Mode":{"$ref":"#\/components\/headers\/AOS-Mode"},"AOS-Credits-Charged":{"$ref":"#\/components\/headers\/AOS-Credits-Charged"},"RateLimit-Limit":{"$ref":"#\/components\/headers\/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#\/components\/headers\/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#\/components\/headers\/RateLimit-Reset"}},"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"ServerError":{"description":"server_error: nothing was charged; retry.","headers":{"AOS-Request-Id":{"$ref":"#\/components\/headers\/AOS-Request-Id"},"AOS-Mode":{"$ref":"#\/components\/headers\/AOS-Mode"},"AOS-Credits-Charged":{"$ref":"#\/components\/headers\/AOS-Credits-Charged"},"RateLimit-Limit":{"$ref":"#\/components\/headers\/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#\/components\/headers\/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#\/components\/headers\/RateLimit-Reset"}},"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"UpstreamUnavailable":{"description":"upstream_unavailable: a court portal is down; nothing was charged.","headers":{"AOS-Request-Id":{"$ref":"#\/components\/headers\/AOS-Request-Id"},"AOS-Mode":{"$ref":"#\/components\/headers\/AOS-Mode"},"AOS-Credits-Charged":{"$ref":"#\/components\/headers\/AOS-Credits-Charged"},"RateLimit-Limit":{"$ref":"#\/components\/headers\/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#\/components\/headers\/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#\/components\/headers\/RateLimit-Reset"}},"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}}}}