https://docs.icepack.ai/getting-started/ Recent content in Getting Started on API Documentation Hugo -- gohugo.io en Tue, 23 Jan 2024 00:00:00 +0000 https://docs.icepack.ai/getting-started/calling-the-api/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/getting-started/calling-the-api/ Public access to the Icepack Portal will be made available soon! In order to call the API you’ll need a few things in place: An API key. A programming language that can form http get and post requests. A model you wish to solve. [1.] To get an API key you’ll need to register an account through the Icepack client portal. Registration is free and we provide a fair-usage policy for small models and request volumes. https://docs.icepack.ai/getting-started/model-submission/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/getting-started/model-submission/ Public access to the Icepack Portal will be made available soon! Armed with your API Key, a language you’re comfortable in, and a model you’d like to submit, we can complete a round trip against the API. Solving models can sometimes take a hot minute. For this reason, when you POST a model to the API, we don’t block and hold the request. Instead, we return a GUID (Globally Unique Identifier) which will allow you to retrieve the results of the solve when they’re complete. https://docs.icepack.ai/getting-started/portal-signup/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/getting-started/portal-signup/ Public access to the Icepack Portal will be made available soon! Initial sign-up You’ll be able to sign up at portal.icepack.ai. Once you’ve registered with a valid email address, you can activate your account by clicking on the link provided in the email you receive from info@icepack.co. After accepting the Terms and Conditions, you will have the freedom to navigate to the different parts of the Client Portal. The initial sign up involves creating a personal account for you under the Standard usage plan. https://docs.icepack.ai/getting-started/protobuf-installation/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/getting-started/protobuf-installation/ Introduction Google provides support for a fantastic serialisation layer called protobuf. It’s fast, typed, and language agnostic. This means you can use it natively from just about any development language. Protobuf is a high-performance serialisation layer. For larger model submissions or responses we recommend using the protobuf interfaces as it is quicker to serialise or deserialise payloads. Part of the reason for this is that the majority of protobuf clients can only serialise a protobuf message if all the required fields are correctly populated. https://docs.icepack.ai/getting-started/what-next/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/getting-started/what-next/ Public access to the Icepack Portal will be made available soon! Now that you know the basics of how to call the API with a model… Play around! Sometimes it’s just fun to know things like how to most efficiently visit all the pubs in Dublin. Audit your historic decisions against optimised models. This is often useful to reveal bottlenecks in processes or reveal areas where things can be tightened up.