Avvoka

Draft a new SINGLE document from a template, providing values for its placeholders and listing the participants (parties/signers). Optionally exports it as a PDF or DOCX. Use this whenever the user wants to "draft", "generate", or "create" a new contract from one template. For a pre-arranged multi-document bundle, use avvoka_create_document_pack instead. If you only have a template name, call avvoka_find_templates first to get the ID. Exactly one of matter_id / profile_id is required. participants is a list of { email, party, role, name?, sign?, edit?, invite?, control? }; party/role must match the template's definitions. entries map each placeholder name to an array of { value, vector? } items. On organisation tokens, owner_user_id is required. The document is auto-named from the template. To rename it, follow up with avvoka_update_document_fields. The author's questionnaire is submitted, so the document ends up in the same state as one completed by a person in the app. By default the document is returned as PDF. Set export_format="docx" for Word, or "none" to skip the export.

avvoka_create_document

Launch a pre-arranged multi-document bundle (a "pack") from a template pack, providing pack-level values and the participants across all member documents. Returns the new pack (clip) and its member documents. Use this when the user wants to start a bundle of related contracts together. For a single document, use avvoka_create_document. If you only have a pack name, call avvoka_find_templates first to get the ID. Exactly one of matter_id / profile_id is required. Every member template's author party must appear in the participants list, otherwise the request is rejected — call avvoka_get_template_pack to see the member templates. On organisation tokens, owner_user_id is required. The author's questionnaire is submitted on every member document, so they end up in the same state as ones completed by a person in the app.

avvoka_create_document_pack

Add a new attribute to the library, so later templates can reuse its name and question definition. Only ever call this when someone has asked for it in as many words. Automating a template, saving a sandbox, or writing a question you think is good are none of them reasons to write to the library. You may suggest a name is worth keeping and then wait to be told. The name is the att a question refers to and has to be unique in the organisation; a clash is refused and names the attribute already holding it. The question is validated as strictly as a question in a sandbox, so a choice type needs its options and a multi_select needs its separator. Pass folder_id to file it in a folder, and user_id to say who authors it when the token belongs to an organisation.

avvoka_create_library_attribute

Get a URL to upload a file to. Nothing is uploaded by this tool: it hands back a one-time URL, someone puts the file there, and the token then names that file for whatever consumes it. If you can reach the file yourself, POST it under the field name `file`: curl -F 'file=@/path/to/file.docx' '<url>' If you cannot reach it, give the URL to the person you are talking to. Opening it in a browser shows a small upload page, and they can tell you once the file is there. A file attached to your conversation is not something you can forward, so this is the way to get one in. Then pass the token to avvoka_import_template, which is the only tool that reads an upload today. The URL expires, refuses anything over the reported size, and stops working once the file has been imported.

avvoka_create_upload

Download a custom clause variant as a PDF or DOCX file. Pass the variant ID (from avvoka_find_and_pick_clause). Returns the file as a downloadable link.

avvoka_export_clause_variant

Download a document or an uploaded attachment as a PDF or DOCX file. Use this when the user wants to "download", "send", "save", or "export" a contract. Pass a document ID for the contract itself, or set kind="attachment" (with the clip_id) for a supporting file. Returns the file as a downloadable link.

avvoka_export_document

Search the custom clauses library — reusable contract paragraphs like indemnity, governing law, or confidentiality. Returns each matching clause with its current published version and that version's variants (e.g. pro-tenant vs pro-landlord wording), so you can pick the right one. Variant body text is not returned inline — download a specific variant with the avvoka_export_clause_variant tool when you need its wording. Results are paginated (page / per_page).

avvoka_find_and_pick_clause

Search documents and document packs in Avvoka by name, matter, template, profile, state, signed status, or creation date. Use this whenever the user refers to a contract by anything other than its ID — e.g. "find the ACME NDA", "show unsigned contracts from last month". Each result has a `type` field — "document" (a single contract) or "document_pack" (a multi-document bundle). For a single document call avvoka_get_document; for a pack call avvoka_get_document_pack. Dates are ISO8601. Filters are AND-combined; comma-separated values within one filter are OR-combined. When `query` is set, packs are matched by their template-pack name. Results are paginated (page / per_page); documents are listed before packs.

avvoka_find_documents

Search the attribute library by name, by question text, or by folder. Returns matching attributes with their name and question text, so you can call avvoka_get_library_attribute for the full definition. Use this before inventing a name for a new question: where an existing attribute means the same thing, reuse its name as the att of the question you create. The library holds names and question definitions only; nothing here is bound to a template. Browse a folder by passing folder_id, which you get from the folders endpoint. Matching covers that folder and all its sub-folders. An unknown folder ID is an error. Deleted attributes are never returned. Results are paginated (page / per_page).

avvoka_find_library_attributes

Search the operation library by name, by description, or by folder. Returns matching operations without their expression, so you can call avvoka_get_library_operation for the ast. Use this before writing an ast of your own: where an existing operation already works out the value you need, reuse it rather than inventing one. The library holds names and expressions only; nothing here is bound to a template. This is the library of operations an organisation has saved. It is not the vocabulary an ast is written in, which avvoka_sandbox_ast_operations reports. Browse a folder by passing folder_id, which you get from the folders endpoint. Matching is on that folder alone, not its sub-folders. Deleted operations are never returned. Results are paginated (page / per_page).

avvoka_find_library_operations