Expand description
Akribes SDK for Rust — typed client for the Akribes workflow platform.
§Quick start
use akribes_sdk::AkribesClient;
let client = AkribesClient::builder("http://localhost:3001")
.project_id(1)
.token("akribes_tk_my_api_key")
.build();
// Run a script and wait for the result
let (id, output) = client.project(1).executions().run("my-script")
.channel("production")
.execute_and_await(None).await?;
println!("Result: {:?}", output.result);Re-exports§
pub use error::AkribesError;pub use error::InputValidationEntry;pub use error::Result;pub use error::parse_input_validation_errors;pub use events::EnvelopeDecodeError;pub use events::EventCategory;pub use events::WorkflowEvent;pub use runtime::RuntimeEndPayload;pub use runtime::RuntimeErrorKind;pub use runtime::RuntimeErrorPayload;pub use runtime::RuntimeEvent;pub use runtime::RuntimeStartPayload;pub use runtime::RuntimeStderrPayload;pub use runtime::RuntimeStdoutPayload;pub use suspend::SuspendTrigger;pub use suspend::UnableRecord;pub use suspend::ValidationErrorWire;pub use task_end::TaskEndVariant;pub use sub::bench::BenchClient;pub use sub::bench::BenchRunsClient;pub use sub::channels::ChannelsClient;pub use sub::clients::RegisteredClientsClient;pub use sub::convert::ConvertClient;pub use sub::documents::DocumentsClient;pub use sub::drafts::DraftsClient;pub use sub::events::EventsClient;pub use sub::executions::ExecutionsClient;pub use sub::projects::ProjectsClient;pub use sub::run_stream::EngineErrorPayload;pub use sub::run_stream::RunStream;pub use sub::run_stream::RunSummary;pub use sub::run_stream::RunSummaryCost;pub use sub::run_stream::RunSummaryDuration;pub use sub::run_stream::RunSummaryTasks;pub use sub::run_stream::SuspendPayload;pub use sub::run_stream::TaskEndPayload;pub use sub::tokens::TokensClient;pub use sub::scripts::ScriptsClient;pub use sub::versions::PublishBuilder;pub use sub::versions::VersionsClient;pub use models::*;
Modules§
- error
- events
- Normalized, client-friendly workflow events.
- models
- runtime
- SDK-facing typed mirror of the engine’s
Runtime*events. - sub
- suspend
- SDK-facing mirror of
akribes_types::event::SuspendTriggerand friends. - task_
end - SDK-facing mirror of
akribes_types::event::TaskEndVariant. - token_
safety - Refuse to embed a non-scoped token in a URL query string.
Structs§
- Akribes
Client - Typed client for the Akribes workflow platform.
- Akribes
Client Builder