Skip to content
Get started

Queue an instruction event

client.meta.instruction(MetaInstructionParams { instruction } body, RequestOptionsoptions?): MetaInstructionResponse { message, status }
POST/public/v1/meta/instruction

Queue an instruction event

ParametersExpand Collapse
body: MetaInstructionParams { instruction }
instruction: string
ReturnsExpand Collapse
MetaInstructionResponse { message, status }
message: string
status: string

Queue an instruction event

import Hyperaide from 'hyperaide';

const client = new Hyperaide({
  apiKey: process.env['HYPERAIDE_API_KEY'], // This is the default and can be omitted
});

const response = await client.meta.instruction({ instruction: 'instruction' });

console.log(response.message);
{
  "message": "message",
  "status": "status"
}
Returns Examples
{
  "message": "message",
  "status": "status"
}