Sanity Library Reference Docs
    Preparing search index...

    Interface AgentActionSyncBeta

    interface AgentActionSync {
        async?: false;
        noWrite?: boolean;
    }
    Index

    Properties

    Properties

    async?: false

    When async: true, requests responds with status 201 and {_id} as response body as soon as the request is validated. The instruction operation will carry on in the background.

    When async: false (default), requests respond with status 200 and the document value after instruction has been applied.

    async: true is incompatible with noWrite: true, as async: true does not return the resulting document

    noWrite?: boolean

    By default, noWrite: false. Write enabled operations will mutate the target document, and emit AI presence in the studio.

    When noWrite: true, the api will not mutate any documents nor emit presence. Ie, when true, no changes will be made to content-lake

    noWrite: true is incompatible with async: true, as noWrite implies that you will use the return value of the operation